github.com/xhghs/rclone@v1.51.1-0.20200430155106-e186a28cced8/docs/content/opendrive.md (about)

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