KurlesHS/rclone
1
0
Fork 0
forked from TrueCloudLab/rclone
Code Pull requests Activity

cmd/gitannex: Describe new rclonelayout config in help

Browse source 
Issue #7625
This commit is contained in:
Dan McArdle 2024-04-11 11:43:44 -04:00 committed by Nick Craig-Wood
parent ad605ee356
commit a675cc6677
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
cmd/gitannex/gitannex.md
View file

@ -16,6 +16,16 @@ Installation on Linux
"git-annex-remote-rclone-builtin", so the symlink from the previous step "git-annex-remote-rclone-builtin", so the symlink from the previous step
should be on your PATH. should be on your PATH.
* NOTE: If you are porting a remote from git-annex-remote-rclone, first
change the externaltype from "rclone" to "rclone-builtin". Watch out, our
configs have slightly different names:
| config for "rclone" | config for "rclone-builtin" |
|:--------------------|:----------------------------|
| `prefix` | `rcloneprefix` |
| `target` | `rcloneremotename` |
| `rclone_layout` | `rclonelayout` |
The following example creates a new git-annex remote named "MyRemote" that The following example creates a new git-annex remote named "MyRemote" that
will use the rclone remote named "SomeRcloneRemote". This rclone remote must will use the rclone remote named "SomeRcloneRemote". This rclone remote must
be configured in your rclone.conf file, wherever that is located on your be configured in your rclone.conf file, wherever that is located on your
@ -27,7 +37,8 @@ Installation on Linux
externaltype=rclone-builtin \ externaltype=rclone-builtin \
encryption=none \ encryption=none \
rcloneremotename=SomeRcloneRemote \ rcloneremotename=SomeRcloneRemote \
rcloneprefix=git-annex-content rcloneprefix=git-annex-content \
rclonelayout=nodir
3. Before you trust this command with your precious data, be sure to **test the 3. Before you trust this command with your precious data, be sure to **test the
remote**. This command is very new and has not been tested on many rclone remote**. This command is very new and has not been tested on many rclone