docs: cleanup header levels in backend docs (#5698)

This commit is contained in:
albertony
2021-10-14 15:40:18 +02:00
committed by GitHub
parent ceaafe6620
commit c2597a4fa3
45 changed files with 608 additions and 523 deletions

View File

@@ -13,6 +13,8 @@ The initial setup for Box involves getting a token from Box which you
can do either in your browser, or with a config.json downloaded from Box
to use JWT authentication. `rclone config` walks you through it.
## Configuration
Here is an example of how to make a remote called `remote`. First run:
rclone config
@@ -99,7 +101,7 @@ To copy a local directory to an Box directory called backup
rclone copy /home/source remote:backup
### Using rclone with an Enterprise account with SSO ###
### Using rclone with an Enterprise account with SSO
If you have an "Enterprise" account type with Box with single sign on
(SSO), you need to create a password to use Box with rclone. This can
@@ -110,7 +112,7 @@ Once you have done this, you can setup your Enterprise Box account
using the same procedure detailed above in the, using the password you
have just set.
### Invalid refresh token ###
### Invalid refresh token
According to the [box docs](https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens):
@@ -194,7 +196,7 @@ d) Delete this remote
y/e/d> y
```
### Modified time and hashes ###
### Modified time and hashes
Box allows modification times to be set on objects accurate to 1
second. These will be used to detect whether objects need syncing or
@@ -203,7 +205,7 @@ not.
Box supports SHA1 type hashes, so you can use the `--checksum`
flag.
#### Restricted filename characters
### Restricted filename characters
In addition to the [default restricted characters set](/overview/#restricted-characters)
the following characters are also replaced:
@@ -222,14 +224,14 @@ These only get replaced if they are the last character in the name:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings.
### Transfers ###
### Transfers
For files above 50 MiB rclone will use a chunked transfer. Rclone will
upload up to `--transfers` chunks at the same time (shared among all
the multipart uploads). Chunks are buffered in memory and are
normally 8 MiB so increasing `--transfers` will increase memory use.
### Deleting files ###
### Deleting files
Depending on the enterprise settings for your user, the item will
either be actually deleted from Box or moved to the trash.
@@ -240,7 +242,7 @@ may take a very long time.
Emptying the trash via the WebUI does not have this limitation
so it is advised to empty the trash via the WebUI.
### Root folder ID ###
### Root folder ID
You can set the `root_folder_id` for rclone. This is the directory
(identified by its `Folder ID`) that rclone considers to be the root
@@ -397,7 +399,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
{{< rem autogenerated options stop >}}
### Limitations ###
## Limitations
Note that Box is case insensitive so you can't have a file called
"Hello.doc" and one called "hello.doc".