TrueCloudLab/rclone
16
0
Fork 2
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions 1
rclone/docs/content/commands/rclone.md

84 lines
4.9 KiB
Markdown
Raw Normal View History

Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
---
title: "rclone"
docs: add description to commands and index page
2020-05-16 14:11:55 +00:00
description: "Show help for rclone commands, flags and backends."
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
slug: rclone
url: /commands/rclone/
gendocs: add autogenerated header to all docs
2020-02-10 12:31:45 +00:00
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/ and as part of making a release run "make commanddocs"
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
---
docs: make command docs titles be one higher
2020-05-22 10:17:37 +00:00
# rclone
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
Version v1.44
2018-10-15 10:03:08 +00:00
Show help for rclone commands, flags and backends.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
docs: make command docs titles be one higher
2020-05-22 10:17:37 +00:00
## Synopsis
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
Version v1.44
2018-10-15 10:03:08 +00:00
Rclone syncs files to and from cloud storage providers as well as
mounting them, listing them in lots of different ways.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
Version v1.44
2018-10-15 10:03:08 +00:00
See the home page (https://rclone.org/) for installation, usage,
documentation, changelog and configuration walkthroughs.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
```
Add ftp.md to docs builder and update docs
2017-06-15 19:12:26 +00:00
rclone [flags]
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
```
docs: make command docs titles be one higher
2020-05-22 10:17:37 +00:00
## Options
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
```
gendocs: remove global flags from command help pages
2019-05-10 22:18:45 +00:00
-h, --help help for rclone
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
```
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-20 15:18:02 +00:00
See the [global flags page](/flags/) for global options not listed here.
docs: make command docs titles be one higher
2020-05-22 10:17:37 +00:00
## SEE ALSO
Version v1.40
2018-03-19 10:06:13 +00:00
Version v1.41
2018-04-28 10:46:27 +00:00
* [rclone about](/commands/rclone_about/) - Get quota information from the remote.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone authorize](/commands/rclone_authorize/) - Remote authorization.
docs: add description to commands and index page
2020-05-16 14:11:55 +00:00
* [rclone backend](/commands/rclone_backend/) - Run a backend specific command.
Version v1.33
2016-08-24 21:58:24 +00:00
* [rclone cat](/commands/rclone_cat/) - Concatenates any files and sends them to stdout.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone check](/commands/rclone_check/) - Checks the files in the source and destination match.
* [rclone cleanup](/commands/rclone_cleanup/) - Clean up the remote if possible
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.
* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping already copied
Version v1.35
2017-01-02 15:30:34 +00:00
* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping already copied
Version v1.43
2018-09-01 11:58:00 +00:00
* [rclone copyurl](/commands/rclone_copyurl/) - Copy url content to dest.
Version v1.37
2017-07-22 17:16:46 +00:00
* [rclone cryptcheck](/commands/rclone_cryptcheck/) - Cryptcheck checks the integrity of a crypted remote.
Version v1.38
2017-09-30 13:19:47 +00:00
* [rclone cryptdecode](/commands/rclone_cryptdecode/) - Cryptdecode returns unencrypted file names.
Version v1.39
2017-12-23 13:07:45 +00:00
* [rclone dedupe](/commands/rclone_dedupe/) - Interactively find duplicate files and delete/rename them.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone delete](/commands/rclone_delete/) - Remove the contents of path.
Version v1.43
2018-09-01 11:58:00 +00:00
* [rclone deletefile](/commands/rclone_deletefile/) - Remove a single file from remote.
support for zsh auto-completion - #983
2017-08-31 14:52:51 +00:00
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied.
docs: make command docs titles be one higher
2020-05-22 10:17:37 +00:00
* [rclone hashsum](/commands/rclone_hashsum/) - Produces a hashsum file for all the objects in the path.
Version v1.41
2018-04-28 10:46:27 +00:00
* [rclone link](/commands/rclone_link/) - Generate public link to file/folder.
Version v1.34
2016-11-06 10:17:52 +00:00
* [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file.
Version v1.40
2018-03-19 10:06:13 +00:00
* [rclone ls](/commands/rclone_ls/) - List the objects in the path with size and path.
Typo: the the -> the in docs and comments
2016-12-31 17:20:31 +00:00
* [rclone lsd](/commands/rclone_lsd/) - List all directories/containers/buckets in the path.
Version v1.40
2018-03-19 10:06:13 +00:00
* [rclone lsf](/commands/rclone_lsf/) - List directories and objects in remote:path formatted for parsing
Add ftp.md to docs builder and update docs
2017-06-15 19:12:26 +00:00
* [rclone lsjson](/commands/rclone_lsjson/) - List directories and objects in the path in JSON format.
Version v1.40
2018-03-19 10:06:13 +00:00
* [rclone lsl](/commands/rclone_lsl/) - List the objects in path with modification time, size and path.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone md5sum](/commands/rclone_md5sum/) - Produces an md5sum file for all the objects in the path.
* [rclone mkdir](/commands/rclone_mkdir/) - Make the path if it doesn't already exist.
Version v1.44
2018-10-15 10:03:08 +00:00
* [rclone mount](/commands/rclone_mount/) - Mount the remote as file system on a mountpoint.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone move](/commands/rclone_move/) - Move files from source to dest.
Version v1.35
2017-01-02 15:30:34 +00:00
* [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest.
Add ftp.md to docs builder and update docs
2017-06-15 19:12:26 +00:00
* [rclone ncdu](/commands/rclone_ncdu/) - Explore a remote with a text based user interface.
Version v1.36
2017-03-18 11:16:43 +00:00
* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone.conf
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents.
Version v1.40
2018-03-19 10:06:13 +00:00
* [rclone rc](/commands/rclone_rc/) - Run a command against a running rclone.
Version v1.38
2017-09-30 13:19:47 +00:00
* [rclone rcat](/commands/rclone_rcat/) - Copies standard input to file on remote.
Version v1.45
2018-11-24 13:44:25 +00:00
* [rclone rcd](/commands/rclone_rcd/) - Run rclone listening to remote control commands only.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone rmdir](/commands/rclone_rmdir/) - Remove the path if empty.
DOC: any empty directoryies -> empty directories (fixes #1546)
2017-07-21 17:17:57 +00:00
* [rclone rmdirs](/commands/rclone_rmdirs/) - Remove empty directories under the path.
Version v1.39
2017-12-23 13:07:45 +00:00
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.
Version v1.44
2018-10-15 10:03:08 +00:00
* [rclone settier](/commands/rclone_settier/) - Changes storage class/tier of objects in remote.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone sha1sum](/commands/rclone_sha1sum/) - Produces an sha1sum file for all the objects in the path.
* [rclone size](/commands/rclone_size/) - Prints the total size and number of objects in remote:path.
* [rclone sync](/commands/rclone_sync/) - Make source and dest identical, modifying destination only.
Version v1.39
2017-12-23 13:07:45 +00:00
* [rclone touch](/commands/rclone_touch/) - Create new file or change file modification time.
Version v1.38
2017-09-30 13:19:47 +00:00
* [rclone tree](/commands/rclone_tree/) - List the contents of the remote in a tree like fashion.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-03 20:36:28 +00:00
* [rclone version](/commands/rclone_version/) - Show the version number.
Reference in a new issue Copy permalink