github/rclone
1
Fork 0
mirror of https://github.com/rclone/rclone synced 2024-11-30 09:10:05 +01:00
Code Releases Activity

docs: extend documentation on valid remote names

Browse Source
This commit is contained in:
albertony 2021-09-16 20:02:16 +02:00
parent 59c74ea1b8
commit 26b6c83e49
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/content/docs.md
View File

@ -328,8 +328,9 @@ Will get their own names
### Valid remote names ### Valid remote names
- Remote names may only contain 0-9, A-Z ,a-z ,_ , - and space. Remote names are case sensitive, and must adhere to the following rules:
- Remote names may not start with -. - May only contain `0`-`9`, `A`-`Z`, `a`-`z`, `_`, `-` and space.
- May not start with `-` or space.
Quoting and the shell Quoting and the shell
--------------------- ---------------------
@ -2168,7 +2169,7 @@ file (using unix ways of setting environment variables):
$ export RCLONE_CONFIG_MYS3_TYPE=s3 $ export RCLONE_CONFIG_MYS3_TYPE=s3
$ export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX $ export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX
$ export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX $ export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX
$ rclone lsd MYS3: $ rclone lsd mys3:
-1 2016-09-21 12:54:21 -1 my-bucket -1 2016-09-21 12:54:21 -1 my-bucket
$ rclone listremotes | grep mys3 $ rclone listremotes | grep mys3
mys3: mys3:
@ -2177,6 +2178,20 @@ mys3:
Note that if you want to create a remote using environment variables Note that if you want to create a remote using environment variables
you must create the `..._TYPE` variable as above. you must create the `..._TYPE` variable as above.
Note that the name of a remote created using environment variable is
case insensitive, in contrast to regular remotes stored in config
file as documented [above](#valid-remote-names).
You must write the name in uppercase in the environment variable, but
as seen from example above it will be listed and can be accessed in
lowercase, while you can also refer to the same remote in uppercase:
```
$ rclone lsd mys3:
-1 2016-09-21 12:54:21 -1 my-bucket
$ rclone lsd MYS3:
-1 2016-09-21 12:54:21 -1 my-bucket
```
Note that you can only set the options of the immediate backend, Note that you can only set the options of the immediate backend,
so RCLONE_CONFIG_MYS3CRYPT_ACCESS_KEY_ID has no effect, if myS3Crypt is so RCLONE_CONFIG_MYS3CRYPT_ACCESS_KEY_ID has no effect, if myS3Crypt is
a crypt remote based on an S3 remote. However RCLONE_S3_ACCESS_KEY_ID will a crypt remote based on an S3 remote. However RCLONE_S3_ACCESS_KEY_ID will