community
/
rclone
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update all auto generated docs

This commit is contained in:
Nick Craig-Wood 2020-05-25 11:59:33 +01:00
parent 256d17eba8
commit 4d6af44045
70 changed files with 98 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/content/commands/rclone.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone" title: "rclone"
description: "Show help for rclone commands, flags and backends." description: "Show help for rclone commands, flags and backends."
slug: rclone slug: rclone

2
docs/content/commands/rclone_about.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone about" title: "rclone about"
description: "Get quota information from the remote." description: "Get quota information from the remote."
slug: rclone_about slug: rclone_about

2
docs/content/commands/rclone_authorize.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone authorize" title: "rclone authorize"
description: "Remote authorization." description: "Remote authorization."
slug: rclone_authorize slug: rclone_authorize

2
docs/content/commands/rclone_backend.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone backend" title: "rclone backend"
description: "Run a backend specific command." description: "Run a backend specific command."
slug: rclone_backend slug: rclone_backend

2
docs/content/commands/rclone_cat.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone cat" title: "rclone cat"
description: "Concatenates any files and sends them to stdout." description: "Concatenates any files and sends them to stdout."
slug: rclone_cat slug: rclone_cat

2
docs/content/commands/rclone_check.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone check" title: "rclone check"
description: "Checks the files in the source and destination match." description: "Checks the files in the source and destination match."
slug: rclone_check slug: rclone_check

2
docs/content/commands/rclone_cleanup.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone cleanup" title: "rclone cleanup"
description: "Clean up the remote if possible" description: "Clean up the remote if possible"
slug: rclone_cleanup slug: rclone_cleanup

2
docs/content/commands/rclone_config.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config" title: "rclone config"
description: "Enter an interactive configuration session." description: "Enter an interactive configuration session."
slug: rclone_config slug: rclone_config

4
docs/content/commands/rclone_config_create.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config create" title: "rclone config create"
description: "Create a new remote with name, type and options." description: "Create a new remote with name, type and options."
slug: rclone_config_create slug: rclone_config_create
@ -14,7 +14,7 @@ Create a new remote with name, type and options.
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 in pairs of `key` `value`. should be passed in pairs of `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
you would do: you would do:

2
docs/content/commands/rclone_config_delete.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config delete" title: "rclone config delete"
description: "Delete an existing remote `name`." description: "Delete an existing remote `name`."
slug: rclone_config_delete slug: rclone_config_delete

2
docs/content/commands/rclone_config_disconnect.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config disconnect" title: "rclone config disconnect"
description: "Disconnects user from remote" description: "Disconnects user from remote"
slug: rclone_config_disconnect slug: rclone_config_disconnect

2
docs/content/commands/rclone_config_dump.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config dump" title: "rclone config dump"
description: "Dump the config file as JSON." description: "Dump the config file as JSON."
slug: rclone_config_dump slug: rclone_config_dump

2
docs/content/commands/rclone_config_edit.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config edit" title: "rclone config edit"
description: "Enter an interactive configuration session." description: "Enter an interactive configuration session."
slug: rclone_config_edit slug: rclone_config_edit

2
docs/content/commands/rclone_config_file.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config file" title: "rclone config file"
description: "Show path of configuration file in use." description: "Show path of configuration file in use."
slug: rclone_config_file slug: rclone_config_file

4
docs/content/commands/rclone_config_password.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config password" title: "rclone config password"
description: "Update password in an existing remote." description: "Update password in an existing remote."
slug: rclone_config_password slug: rclone_config_password
@ -14,7 +14,7 @@ Update password in an existing remote.
Update an existing remote's password. The password Update an existing remote's password. The password
should be passed in in pairs of `key` `value`. should be passed in pairs of `key` `value`.
For example to set password of a remote of name myremote you would do: For example to set password of a remote of name myremote you would do:

2
docs/content/commands/rclone_config_providers.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config providers" title: "rclone config providers"
description: "List in JSON format all the providers and options." description: "List in JSON format all the providers and options."
slug: rclone_config_providers slug: rclone_config_providers

2
docs/content/commands/rclone_config_reconnect.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config reconnect" title: "rclone config reconnect"
description: "Re-authenticates user with remote." description: "Re-authenticates user with remote."
slug: rclone_config_reconnect slug: rclone_config_reconnect

2
docs/content/commands/rclone_config_show.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config show" title: "rclone config show"
description: "Print (decrypted) config file, or the config for a single remote." description: "Print (decrypted) config file, or the config for a single remote."
slug: rclone_config_show slug: rclone_config_show

2
docs/content/commands/rclone_config_update.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config update" title: "rclone config update"
description: "Update options in an existing remote." description: "Update options in an existing remote."
slug: rclone_config_update slug: rclone_config_update

2
docs/content/commands/rclone_config_userinfo.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone config userinfo" title: "rclone config userinfo"
description: "Prints info about logged in user of remote." description: "Prints info about logged in user of remote."
slug: rclone_config_userinfo slug: rclone_config_userinfo

2
docs/content/commands/rclone_copy.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone copy" title: "rclone copy"
description: "Copy files from source to dest, skipping already copied" description: "Copy files from source to dest, skipping already copied"
slug: rclone_copy slug: rclone_copy

2
docs/content/commands/rclone_copyto.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone copyto" title: "rclone copyto"
description: "Copy files from source to dest, skipping already copied" description: "Copy files from source to dest, skipping already copied"
slug: rclone_copyto slug: rclone_copyto

4
docs/content/commands/rclone_copyurl.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone copyurl" title: "rclone copyurl"
description: "Copy url content to dest." description: "Copy url content to dest."
slug: rclone_copyurl slug: rclone_copyurl
@ -16,7 +16,7 @@ Copy url content to dest.
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 cause the file name to be retreived from Setting --auto-filename will cause the file name to be retrieved from
the from URL (after any redirections) and used in the destination the from URL (after any redirections) and used in the destination
path. path.

2
docs/content/commands/rclone_cryptcheck.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone cryptcheck" title: "rclone cryptcheck"
description: "Cryptcheck checks the integrity of a crypted remote." description: "Cryptcheck checks the integrity of a crypted remote."
slug: rclone_cryptcheck slug: rclone_cryptcheck

2
docs/content/commands/rclone_cryptdecode.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone cryptdecode" title: "rclone cryptdecode"
description: "Cryptdecode returns unencrypted file names." description: "Cryptdecode returns unencrypted file names."
slug: rclone_cryptdecode slug: rclone_cryptdecode

2
docs/content/commands/rclone_dedupe.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone dedupe" title: "rclone dedupe"
description: "Interactively find duplicate files and delete/rename them." description: "Interactively find duplicate files and delete/rename them."
slug: rclone_dedupe slug: rclone_dedupe

2
docs/content/commands/rclone_delete.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone delete" title: "rclone delete"
description: "Remove the contents of path." description: "Remove the contents of path."
slug: rclone_delete slug: rclone_delete

2
docs/content/commands/rclone_deletefile.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone deletefile" title: "rclone deletefile"
description: "Remove a single file from remote." description: "Remove a single file from remote."
slug: rclone_deletefile slug: rclone_deletefile

2
docs/content/commands/rclone_genautocomplete.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone genautocomplete" title: "rclone genautocomplete"
description: "Output completion script for a given shell." description: "Output completion script for a given shell."
slug: rclone_genautocomplete slug: rclone_genautocomplete

2
docs/content/commands/rclone_genautocomplete_bash.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone genautocomplete bash" title: "rclone genautocomplete bash"
description: "Output bash completion script for rclone." description: "Output bash completion script for rclone."
slug: rclone_genautocomplete_bash slug: rclone_genautocomplete_bash

2
docs/content/commands/rclone_genautocomplete_fish.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone genautocomplete fish" title: "rclone genautocomplete fish"
description: "Output fish completion script for rclone." description: "Output fish completion script for rclone."
slug: rclone_genautocomplete_fish slug: rclone_genautocomplete_fish

2
docs/content/commands/rclone_genautocomplete_zsh.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone genautocomplete zsh" title: "rclone genautocomplete zsh"
description: "Output zsh completion script for rclone." description: "Output zsh completion script for rclone."
slug: rclone_genautocomplete_zsh slug: rclone_genautocomplete_zsh

2
docs/content/commands/rclone_gendocs.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone gendocs" title: "rclone gendocs"
description: "Output markdown docs for rclone to the directory supplied." description: "Output markdown docs for rclone to the directory supplied."
slug: rclone_gendocs slug: rclone_gendocs

2
docs/content/commands/rclone_hashsum.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone hashsum" title: "rclone hashsum"
description: "Produces a hashsum file for all the objects in the path." description: "Produces a hashsum file for all the objects in the path."
slug: rclone_hashsum slug: rclone_hashsum

2
docs/content/commands/rclone_link.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone link" title: "rclone link"
description: "Generate public link to file/folder." description: "Generate public link to file/folder."
slug: rclone_link slug: rclone_link

2
docs/content/commands/rclone_listremotes.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone listremotes" title: "rclone listremotes"
description: "List all the remotes in the config file." description: "List all the remotes in the config file."
slug: rclone_listremotes slug: rclone_listremotes

2
docs/content/commands/rclone_ls.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone ls" title: "rclone ls"
description: "List the objects in the path with size and path." description: "List the objects in the path with size and path."
slug: rclone_ls slug: rclone_ls

2
docs/content/commands/rclone_lsd.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone lsd" title: "rclone lsd"
description: "List all directories/containers/buckets in the path." description: "List all directories/containers/buckets in the path."
slug: rclone_lsd slug: rclone_lsd

2
docs/content/commands/rclone_lsf.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone lsf" title: "rclone lsf"
description: "List directories and objects in remote:path formatted for parsing" description: "List directories and objects in remote:path formatted for parsing"
slug: rclone_lsf slug: rclone_lsf

2
docs/content/commands/rclone_lsjson.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone lsjson" title: "rclone lsjson"
description: "List directories and objects in the path in JSON format." description: "List directories and objects in the path in JSON format."
slug: rclone_lsjson slug: rclone_lsjson

2
docs/content/commands/rclone_lsl.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone lsl" title: "rclone lsl"
description: "List the objects in path with modification time, size and path." description: "List the objects in path with modification time, size and path."
slug: rclone_lsl slug: rclone_lsl

2
docs/content/commands/rclone_md5sum.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone md5sum" title: "rclone md5sum"
description: "Produces an md5sum file for all the objects in the path." description: "Produces an md5sum file for all the objects in the path."
slug: rclone_md5sum slug: rclone_md5sum

2
docs/content/commands/rclone_mkdir.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone mkdir" title: "rclone mkdir"
description: "Make the path if it doesn't already exist." description: "Make the path if it doesn't already exist."
slug: rclone_mkdir slug: rclone_mkdir

8
docs/content/commands/rclone_mount.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone mount" title: "rclone mount"
description: "Mount the remote as file system on a mountpoint." description: "Mount the remote as file system on a mountpoint."
slug: rclone_mount slug: rclone_mount
@ -55,7 +55,7 @@ Stopping the mount manually:
To run rclone mount on Windows, you will need to To run rclone mount on Windows, you will need to
download and install [WinFsp](http://www.secfs.net/winfsp/). download and install [WinFsp](http://www.secfs.net/winfsp/).
WinFsp is an [open source](https://github.com/billziss-gh/winfsp) [WinFsp](https://github.com/billziss-gh/winfsp) is an open source
Windows File System Proxy which makes it easy to write user space file Windows File System Proxy which makes it easy to write user space file
systems for Windows. It provides a FUSE emulation layer which rclone systems for Windows. It provides a FUSE emulation layer which rclone
uses combination with uses combination with
@ -342,7 +342,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query. to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case. It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -364,7 +364,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target. The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false" on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true". otherwise. If the flag is provided without a value, then it is "true".

2
docs/content/commands/rclone_move.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone move" title: "rclone move"
description: "Move files from source to dest." description: "Move files from source to dest."
slug: rclone_move slug: rclone_move

2
docs/content/commands/rclone_moveto.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone moveto" title: "rclone moveto"
description: "Move file or directory from source to dest." description: "Move file or directory from source to dest."
slug: rclone_moveto slug: rclone_moveto

2
docs/content/commands/rclone_ncdu.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone ncdu" title: "rclone ncdu"
description: "Explore a remote with a text based user interface." description: "Explore a remote with a text based user interface."
slug: rclone_ncdu slug: rclone_ncdu

2
docs/content/commands/rclone_obscure.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone obscure" title: "rclone obscure"
description: "Obscure password for use in the rclone.conf" description: "Obscure password for use in the rclone.conf"
slug: rclone_obscure slug: rclone_obscure

2
docs/content/commands/rclone_purge.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone purge" title: "rclone purge"
description: "Remove the path and all of its contents." description: "Remove the path and all of its contents."
slug: rclone_purge slug: rclone_purge

2
docs/content/commands/rclone_rc.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone rc" title: "rclone rc"
description: "Run a command against a running rclone." description: "Run a command against a running rclone."
slug: rclone_rc slug: rclone_rc

2
docs/content/commands/rclone_rcat.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone rcat" title: "rclone rcat"
description: "Copies standard input to file on remote." description: "Copies standard input to file on remote."
slug: rclone_rcat slug: rclone_rcat

2
docs/content/commands/rclone_rcd.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone rcd" title: "rclone rcd"
description: "Run rclone listening to remote control commands only." description: "Run rclone listening to remote control commands only."
slug: rclone_rcd slug: rclone_rcd

2
docs/content/commands/rclone_rmdir.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone rmdir" title: "rclone rmdir"
description: "Remove the path if empty." description: "Remove the path if empty."
slug: rclone_rmdir slug: rclone_rmdir

2
docs/content/commands/rclone_rmdirs.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone rmdirs" title: "rclone rmdirs"
description: "Remove empty directories under the path." description: "Remove empty directories under the path."
slug: rclone_rmdirs slug: rclone_rmdirs

2
docs/content/commands/rclone_serve.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone serve" title: "rclone serve"
description: "Serve a remote over a protocol." description: "Serve a remote over a protocol."
slug: rclone_serve slug: rclone_serve

8
docs/content/commands/rclone_serve_dlna.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone serve dlna" title: "rclone serve dlna"
description: "Serve remote:path over DLNA" description: "Serve remote:path over DLNA"
slug: rclone_serve_dlna slug: rclone_serve_dlna
@ -12,7 +12,7 @@ Serve remote:path over DLNA
## Synopsis ## Synopsis
rclone serve dlna is a DLNA media server for media stored in a rclone remote. Many rclone serve dlna is a DLNA media server for media stored in an rclone remote. Many
devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN
and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast
packets (SSDP) and will thus only work on LANs. packets (SSDP) and will thus only work on LANs.
@ -181,7 +181,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query. to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case. It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -203,7 +203,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target. The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false" on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true". otherwise. If the flag is provided without a value, then it is "true".

8
docs/content/commands/rclone_serve_ftp.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone serve ftp" title: "rclone serve ftp"
description: "Serve remote:path over FTP." description: "Serve remote:path over FTP."
slug: rclone_serve_ftp slug: rclone_serve_ftp
@ -180,7 +180,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query. to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case. It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -202,7 +202,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target. The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false" on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true". otherwise. If the flag is provided without a value, then it is "true".
## Auth Proxy ## Auth Proxy
@ -272,7 +272,7 @@ that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp parameter before creating the backend (which is required for sftp
backends). backends).
The progam can manipulate the supplied `user` in any way, for example The program can manipulate the supplied `user` in any way, for example
to make proxy to many different sftp backends, you could make the to make proxy to many different sftp backends, you could make the
`user` be `user@example.com` and then set the `host` to `example.com` `user` be `user@example.com` and then set the `host` to `example.com`
in the output and the user to `user`. For security you'd probably want in the output and the user to `user`. For security you'd probably want

6
docs/content/commands/rclone_serve_http.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone serve http" title: "rclone serve http"
description: "Serve the remote over HTTP." description: "Serve the remote over HTTP."
slug: rclone_serve_http slug: rclone_serve_http
@ -252,7 +252,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query. to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case. It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -274,7 +274,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target. The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false" on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true". otherwise. If the flag is provided without a value, then it is "true".

2
docs/content/commands/rclone_serve_restic.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone serve restic" title: "rclone serve restic"
description: "Serve the remote for restic's REST API." description: "Serve the remote for restic's REST API."
slug: rclone_serve_restic slug: rclone_serve_restic

8
docs/content/commands/rclone_serve_sftp.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone serve sftp" title: "rclone serve sftp"
description: "Serve the remote over SFTP." description: "Serve the remote over SFTP."
slug: rclone_serve_sftp slug: rclone_serve_sftp
@ -191,7 +191,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query. to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case. It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -213,7 +213,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target. The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false" on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true". otherwise. If the flag is provided without a value, then it is "true".
## Auth Proxy ## Auth Proxy
@ -283,7 +283,7 @@ that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp parameter before creating the backend (which is required for sftp
backends). backends).
The progam can manipulate the supplied `user` in any way, for example The program can manipulate the supplied `user` in any way, for example
to make proxy to many different sftp backends, you could make the to make proxy to many different sftp backends, you could make the
`user` be `user@example.com` and then set the `host` to `example.com` `user` be `user@example.com` and then set the `host` to `example.com`
in the output and the user to `user`. For security you'd probably want in the output and the user to `user`. For security you'd probably want

8
docs/content/commands/rclone_serve_webdav.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone serve webdav" title: "rclone serve webdav"
description: "Serve remote:path over webdav." description: "Serve remote:path over webdav."
slug: rclone_serve_webdav slug: rclone_serve_webdav
@ -260,7 +260,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query. to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case. It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -282,7 +282,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target. The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false" on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true". otherwise. If the flag is provided without a value, then it is "true".
## Auth Proxy ## Auth Proxy
@ -352,7 +352,7 @@ that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp parameter before creating the backend (which is required for sftp
backends). backends).
The progam can manipulate the supplied `user` in any way, for example The program can manipulate the supplied `user` in any way, for example
to make proxy to many different sftp backends, you could make the to make proxy to many different sftp backends, you could make the
`user` be `user@example.com` and then set the `host` to `example.com` `user` be `user@example.com` and then set the `host` to `example.com`
in the output and the user to `user`. For security you'd probably want in the output and the user to `user`. For security you'd probably want

2
docs/content/commands/rclone_settier.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone settier" title: "rclone settier"
description: "Changes storage class/tier of objects in remote." description: "Changes storage class/tier of objects in remote."
slug: rclone_settier slug: rclone_settier

2
docs/content/commands/rclone_sha1sum.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone sha1sum" title: "rclone sha1sum"
description: "Produces an sha1sum file for all the objects in the path." description: "Produces an sha1sum file for all the objects in the path."
slug: rclone_sha1sum slug: rclone_sha1sum

2
docs/content/commands/rclone_size.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone size" title: "rclone size"
description: "Prints the total size and number of objects in remote:path." description: "Prints the total size and number of objects in remote:path."
slug: rclone_size slug: rclone_size

2
docs/content/commands/rclone_sync.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone sync" title: "rclone sync"
description: "Make source and dest identical, modifying destination only." description: "Make source and dest identical, modifying destination only."
slug: rclone_sync slug: rclone_sync

2
docs/content/commands/rclone_touch.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone touch" title: "rclone touch"
description: "Create new file or change file modification time." description: "Create new file or change file modification time."
slug: rclone_touch slug: rclone_touch

2
docs/content/commands/rclone_tree.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone tree" title: "rclone tree"
description: "List the contents of the remote in a tree like fashion." description: "List the contents of the remote in a tree like fashion."
slug: rclone_tree slug: rclone_tree

2
docs/content/commands/rclone_version.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-05-22T15:09:46+01:00 date: 2020-05-25T12:06:00+01:00
title: "rclone version" title: "rclone version"
description: "Show the version number." description: "Show the version number."
slug: rclone_version slug: rclone_version

14
docs/content/flags.md
View File

@ -1,7 +1,7 @@
--- ---
title: "Global Flags" title: "Global Flags"
description: "Rclone Global Flags" description: "Rclone Global Flags"
date: "2020-05-22T15:09:46+01:00" date: "2020-05-25T12:06:00+01:00"
--- ---
# Global Flags # Global Flags
@ -22,6 +22,7 @@ These flags are available for every command.
--bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable.
--ca-cert string CA certificate used to verify servers --ca-cert string CA certificate used to verify servers
--cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone")
--check-first Do all the checks before starting transfers.
--checkers int Number of checkers to run in parallel. (default 8) --checkers int Number of checkers to run in parallel. (default 8)
-c, --checksum Skip based on checksum (if available) & size, not mod-time & size -c, --checksum Skip based on checksum (if available) & size, not mod-time & size
--client-cert string Client SSL certificate (PEM) for mutual TLS auth --client-cert string Client SSL certificate (PEM) for mutual TLS auth
@ -144,7 +145,7 @@ These flags are available for every command.
--use-json-log Use json log format. --use-json-log Use json log format.
--use-mmap Use mmap allocator (see docs). --use-mmap Use mmap allocator (see docs).
--use-server-modtime Use server modified time instead of object metadata --use-server-modtime Use server modified time instead of object metadata
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.51.0-383-g3bc9a985-new-docs-beta") --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.51.0-411-gaebb535f-new-docs-beta")
-v, --verbose count Print lots more stuff (repeat for more) -v, --verbose count Print lots more stuff (repeat for more)
``` ```
@ -204,7 +205,7 @@ and may be set in the config file.
--cache-db-purge Clear all the cached data for this remote on start. --cache-db-purge Clear all the cached data for this remote on start.
--cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s)
--cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) --cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-plex-insecure string Skip all certificate verifications when connecting to the Plex server --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server
--cache-plex-password string The password of the Plex user --cache-plex-password string The password of the Plex user
--cache-plex-url string The URL of the Plex server --cache-plex-url string The URL of the Plex server
--cache-plex-username string The username of the Plex user --cache-plex-username string The username of the Plex user
@ -388,7 +389,7 @@ and may be set in the config file.
--s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3.
--s3-session-token string An AWS session token --s3-session-token string An AWS session token
--s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
--s3-sse-customer-key string If using SSE-C you must provide the secret encyption key used to encrypt/decrypt your data. --s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
--s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum.
--s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key.
--s3-storage-class string The storage class to use when storing new objects in S3. --s3-storage-class string The storage class to use when storing new objects in S3.
@ -396,13 +397,14 @@ and may be set in the config file.
--s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M)
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint.
--s3-v2-auth If true use v2 authentication. --s3-v2-auth If true use v2 authentication.
--seafile-create-library Should create library if it doesn't exist --seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled)
--seafile-create-library Should rclone create a library if it doesn't exist
--seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) --seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
--seafile-library string Name of the library. Leave blank to access all non-encrypted libraries. --seafile-library string Name of the library. Leave blank to access all non-encrypted libraries.
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. --seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
--seafile-pass string Password --seafile-pass string Password
--seafile-url string URL of seafile host to connect to --seafile-url string URL of seafile host to connect to
--seafile-user string User name --seafile-user string User name (usually email address)
--sftp-ask-password Allow asking for SFTP password when needed. --sftp-ask-password Allow asking for SFTP password when needed.
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available.
--sftp-host string SSH host to connect to --sftp-host string SSH host to connect to

4
docs/content/rc.md
View File

@ -316,7 +316,7 @@ command:
rclone backend noop . -o echo=yes -o blue path1 path2 rclone backend noop . -o echo=yes -o blue path1 path2
Note that arguments must be preceeded by the "-a" flag Note that arguments must be preceded by the "-a" flag
See the [backend](/commands/rclone_backend/) command for more information. See the [backend](/commands/rclone_backend/) command for more information.
@ -629,7 +629,7 @@ Returns the following values:
"bytes": total transferred bytes for this file, "bytes": total transferred bytes for this file,
"checked": if the transfer is only checked (skipped, deleted), "checked": if the transfer is only checked (skipped, deleted),
"timestamp": integer representing millisecond unix epoch, "timestamp": integer representing millisecond unix epoch,
"error": string description of the error (empty if successfull), "error": string description of the error (empty if successful),
"jobid": id of the job that this transfer belongs to "jobid": id of the job that this transfer belongs to
} }
] ]