extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-12-22 23:22:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify option syntax

Browse Source 
See: https://forum.rclone.org/t/seeming-documentation-problem-rclones-syntax-a-problem-with-the-categories-on-this-forum/45395/
This commit is contained in:
Nick Craig-Wood 2024-04-05 15:57:50 +01:00
parent 6da27db844
commit 6a5c0065ef
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/content/docs.md
View File

@ -91,7 +91,24 @@ Rclone syncs a directory tree from one storage system to another.
Its syntax is like this
Syntax: [options] subcommand <parameters> <parameters...>
rclone subcommand [options] <parameters> <parameters...>
A `subcommand` is a the rclone operation required, (e.g. `sync`,
`copy`, `ls`).
An `option` is a single letter flag (e.g. `-v`) or a group of single
letter flags (e.g. `-Pv`) or a long flag (e.g. `--progress`). No
options are required. Options can come after the `subcommand` or in
between parameters too or on the end, but only global options can be
used before the `subcommand`. Anything after a `--` option will not be
interpreted as an option so if you need to add a parameter which
starts with a `-` then put a `--` on its own first, eg
rclone lsf -- -directory-starting-with-dash
A `parameter` is usually a file path or [rclone remote](#syntax-of-remote-paths), eg
`/path/to/file` or `remote:path/to/file` but it can be other things -
the `subcommand` help will tell you what.
Source and destination paths are specified by the name you gave the
storage system in the config file then the sub path, e.g.