github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/cmd/bisync/help.go (about)

     1  package bisync
     2  
     3  import (
     4  	"strconv"
     5  	"strings"
     6  )
     7  
     8  func makeHelp(help string) string {
     9  	replacer := strings.NewReplacer(
    10  		"|", "`",
    11  		"{MAXDELETE}", strconv.Itoa(DefaultMaxDelete),
    12  		"{CHECKFILE}", DefaultCheckFilename,
    13  		// "{WORKDIR}", DefaultWorkdir,
    14  	)
    15  	return replacer.Replace(help)
    16  }
    17  
    18  var shortHelp = `Perform bidirectional synchronization between two paths.`
    19  
    20  var rcHelp = makeHelp(`This takes the following parameters
    21  
    22  - path1 - a remote directory string e.g. |drive:path1|
    23  - path2 - a remote directory string e.g. |drive:path2|
    24  - dryRun - dry-run mode
    25  - resync - performs the resync run
    26  - checkAccess - abort if {CHECKFILE} files are not found on both filesystems
    27  - checkFilename - file name for checkAccess (default: {CHECKFILE})
    28  - maxDelete - abort sync if percentage of deleted files is above
    29    this threshold (default: {MAXDELETE})
    30  - force - Bypass maxDelete safety check and run the sync
    31  - checkSync - |true| by default, |false| disables comparison of final listings,
    32                |only| will skip sync, only compare listings from the last run
    33  - createEmptySrcDirs - Sync creation and deletion of empty directories. 
    34  			  (Not compatible with --remove-empty-dirs)
    35  - removeEmptyDirs - remove empty directories at the final cleanup step
    36  - filtersFile - read filtering patterns from a file
    37  - ignoreListingChecksum - Do not use checksums for listings
    38  - resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync. 
    39              Use at your own risk!
    40  - workdir - server directory for history files (default: |~/.cache/rclone/bisync|)
    41  - backupdir1 - --backup-dir for Path1. Must be a non-overlapping path on the same remote.
    42  - backupdir2 - --backup-dir for Path2. Must be a non-overlapping path on the same remote.
    43  - noCleanup - retain working files
    44  
    45  See [bisync command help](https://rclone.org/commands/rclone_bisync/)
    46  and [full bisync description](https://rclone.org/bisync/)
    47  for more information.`)
    48  
    49  var longHelp = shortHelp + makeHelp(`
    50  
    51  [Bisync](https://rclone.org/bisync/) provides a
    52  bidirectional cloud sync solution in rclone.
    53  It retains the Path1 and Path2 filesystem listings from the prior run.
    54  On each successive run it will:
    55  - list files on Path1 and Path2, and check for changes on each side.
    56    Changes include |New|, |Newer|, |Older|, and |Deleted| files.
    57  - Propagate changes on Path1 to Path2, and vice-versa.
    58  
    59  Bisync is **in beta** and is considered an **advanced command**, so use with care.
    60  Make sure you have read and understood the entire [manual](https://rclone.org/bisync)
    61  (especially the [Limitations](https://rclone.org/bisync/#limitations) section) before using,
    62  or data loss can result. Questions can be asked in the [Rclone Forum](https://forum.rclone.org/).
    63  
    64  See [full bisync description](https://rclone.org/bisync/) for details.
    65  `)