github.com/10XDev/rclone@v1.52.3-0.20200626220027-16af9ab76b2a/docs/content/opendrive.md (about)

     1  ---
     2  title: "OpenDrive"
     3  description: "Rclone docs for OpenDrive"
     4  ---
     5  
     6  {{< icon "fa fa-file" >}} OpenDrive
     7  ------------------------------------
     8  
     9  Paths are specified as `remote:path`
    10  
    11  Paths may be as deep as required, eg `remote:directory/subdirectory`.
    12  
    13  Here is an example of how to make a remote called `remote`.  First run:
    14  
    15       rclone config
    16  
    17  This will guide you through an interactive setup process:
    18  
    19  ```
    20  n) New remote
    21  d) Delete remote
    22  q) Quit config
    23  e/n/d/q> n
    24  name> remote
    25  Type of storage to configure.
    26  Choose a number from below, or type in your own value
    27  [snip]
    28  XX / OpenDrive
    29     \ "opendrive"
    30  [snip]
    31  Storage> opendrive
    32  Username
    33  username>
    34  Password
    35  y) Yes type in my own password
    36  g) Generate random password
    37  y/g> y
    38  Enter the password:
    39  password:
    40  Confirm the password:
    41  password:
    42  --------------------
    43  [remote]
    44  username =
    45  password = *** ENCRYPTED ***
    46  --------------------
    47  y) Yes this is OK
    48  e) Edit this remote
    49  d) Delete this remote
    50  y/e/d> y
    51  ```
    52  
    53  List directories in top level of your OpenDrive
    54  
    55      rclone lsd remote:
    56  
    57  List all the files in your OpenDrive
    58  
    59      rclone ls remote:
    60  
    61  To copy a local directory to an OpenDrive directory called backup
    62  
    63      rclone copy /home/source remote:backup
    64  
    65  ### Modified time and MD5SUMs ###
    66  
    67  OpenDrive allows modification times to be set on objects accurate to 1
    68  second. These will be used to detect whether objects need syncing or
    69  not.
    70  
    71  #### Restricted filename characters
    72  
    73  | Character | Value | Replacement |
    74  | --------- |:-----:|:-----------:|
    75  | NUL       | 0x00  | ␀           |
    76  | /         | 0x2F  | ／          |
    77  | "         | 0x22  | ＂          |
    78  | *         | 0x2A  | ＊          |
    79  | :         | 0x3A  | ：          |
    80  | <         | 0x3C  | ＜          |
    81  | >         | 0x3E  | ＞          |
    82  | ?         | 0x3F  | ？          |
    83  | \         | 0x5C  | ＼          |
    84  | \|        | 0x7C  | ｜          |
    85  
    86  File names can also not begin or end with the following characters.
    87  These only get replaced if they are the first or last character in the name:
    88  
    89  | Character | Value | Replacement |
    90  | --------- |:-----:|:-----------:|
    91  | SP        | 0x20  | ␠           |
    92  | HT        | 0x09  | ␉           |
    93  | LF        | 0x0A  | ␊           |
    94  | VT        | 0x0B  | ␋           |
    95  | CR        | 0x0D  | ␍           |
    96  
    97  
    98  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
    99  as they can't be used in JSON strings.
   100  
   101  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/opendrive/opendrive.go then run make backenddocs" >}}
   102  ### Standard Options
   103  
   104  Here are the standard options specific to opendrive (OpenDrive).
   105  
   106  #### --opendrive-username
   107  
   108  Username
   109  
   110  - Config:      username
   111  - Env Var:     RCLONE_OPENDRIVE_USERNAME
   112  - Type:        string
   113  - Default:     ""
   114  
   115  #### --opendrive-password
   116  
   117  Password.
   118  
   119  **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
   120  
   121  - Config:      password
   122  - Env Var:     RCLONE_OPENDRIVE_PASSWORD
   123  - Type:        string
   124  - Default:     ""
   125  
   126  ### Advanced Options
   127  
   128  Here are the advanced options specific to opendrive (OpenDrive).
   129  
   130  #### --opendrive-encoding
   131  
   132  This sets the encoding for the backend.
   133  
   134  See: the [encoding section in the overview](/overview/#encoding) for more info.
   135  
   136  - Config:      encoding
   137  - Env Var:     RCLONE_OPENDRIVE_ENCODING
   138  - Type:        MultiEncoder
   139  - Default:     Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot
   140  
   141  #### --opendrive-chunk-size
   142  
   143  Files will be uploaded in chunks this size.
   144  
   145  Note that these chunks are buffered in memory so increasing them will
   146  increase memory use.
   147  
   148  - Config:      chunk_size
   149  - Env Var:     RCLONE_OPENDRIVE_CHUNK_SIZE
   150  - Type:        SizeSuffix
   151  - Default:     10M
   152  
   153  {{< rem autogenerated options stop >}}
   154  
   155  ### Limitations ###
   156  
   157  Note that OpenDrive is case insensitive so you can't have a
   158  file called "Hello.doc" and one called "hello.doc".
   159  
   160  There are quite a few characters that can't be in OpenDrive file
   161  names.  These can't occur on Windows platforms, but on non-Windows
   162  platforms they are common.  Rclone will map these names to and from an
   163  identical looking unicode equivalent.  For example if a file has a `?`
   164  in it will be mapped to `？` instead.
   165