bisync: documentation #5164

Co-authored-by: Chris Nelson <stuff@cjnaz.com>

cmd/bisync/help.go

@@ -17,10 +17,37 @@ func makeHelp(help string) string {
 
 var shortHelp = `Perform bidirectonal synchronization between two paths.`
 
-var rcHelp = makeHelp(`
-TODO
-`)
+var rcHelp = makeHelp(`This takes the following parameters
+
+- path1 - a remote directory string e.g. |drive:path1|
+- path2 - a remote directory string e.g. |drive:path2|
+- dryRun - dry-run mode
+- resync - performs the resync run
+- checkAccess - abort if {CHECKFILE} files are not found on both filesystems
+- checkFilename - file name for checkAccess (default: {CHECKFILE})
+- maxDelete - abort sync if percentage of deleted files is above
+  this threshold (default: {MAXDELETE})
+- force - maxDelete safety check and run the sync
+- checkSync - |true| by default, |false| disables comparison of final listings,
+              |only| will skip sync, only compare listings from the last run
+- removeEmptyDirs - remove empty directories at the final cleanup step
+- filtersFile - read filtering patterns from a file
+- workdir - server directory for history files (default: {WORKDIR})
+- noCleanup - retain working files
+
+See [bisync command help](https://rclone.org/commands/rclone_bisync/)
+and [full bisync description](https://rclone.org/bisync/)
+for more information.`)
 
 var longHelp = shortHelp + makeHelp(`
-TODO
+
+[Bisync](https://rclone.org/bisync/) provides a
+bidirectional cloud sync solution in rclone.
+It retains the Path1 and Path2 filesystem listings from the prior run.
+On each successive run it will:
+- list files on Path1 and Path2, and check for changes on each side.
+  Changes include |New|, |Newer|, |Older|, and |Deleted| files.
+- Propagate changes on Path1 to Path2, and vice-versa.
+
+See [full bisync description](https://rclone.org/bisync/) for details.
 `)

docs/content/commands/rclone_bisync.md

@@ -0,0 +1,52 @@
+---
+title: "rclone bisync"
+description: "Perform bidirectonal synchronization between two paths."
+slug: rclone_bisync
+url: /commands/rclone_bisync/
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/bisync/ and as part of making a release run "make commanddocs"
+---
+# rclone bisync
+
+Perform bidirectonal synchronization between two paths.
+
+## Synopsis
+
+Perform bidirectonal synchronization between two paths.
+
+[Bisync](https://rclone.org/bisync/) provides a
+bidirectional cloud sync solution in rclone.
+It retains the Path1 and Path2 filesystem listings from the prior run.
+On each successive run it will:
+- list files on Path1 and Path2, and check for changes on each side.
+  Changes include `New`, `Newer`, `Older`, and `Deleted` files.
+- Propagate changes on Path1 to Path2, and vice-versa.
+
+See [full bisync description](https://rclone.org/bisync/) for details.
+
+
+```
+rclone bisync remote1:path1 remote2:path2 [flags]
+```
+
+## Options
+
+```
+      --check-access            Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort.
+      --check-filename string   Filename for --check-access (default: RCLONE_TEST)
+      --check-sync string       Controls comparison of final listings: true|false|only (default: true) (default "true")
+      --filters-file string     Read filtering patterns from a file
+      --force                   Bypass --max-delete safety check and run the sync. Consider using with --verbose
+  -h, --help                    help for bisync
+      --localtime               Use local time in listings (default: UTC)
+      --no-cleanup              Retain working files (useful for troubleshooting and testing).
+      --remove-empty-dirs       Remove empty directories at the final cleanup step.
+  -1, --resync                  Performs the resync run. Path1 files may overwrite Path2 versions. Consider using --verbose or --dry-run first.
+      --workdir string          Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync)
+```
+
+See the [global flags page](/flags/) for global options not listed here.
+
+## SEE ALSO
+
+* [rclone](/commands/rclone/)	 - Show help for rclone commands, flags and backends.
+

docs/content/docs.md

@@ -105,6 +105,7 @@ The main rclone commands with most used first
 * [rclone config](/commands/rclone_config/)	- Enter an interactive configuration session.
 * [rclone copy](/commands/rclone_copy/)		- Copy files from source to dest, skipping already copied.
 * [rclone sync](/commands/rclone_sync/)		- Make source and dest identical, modifying destination only.
+* [rclone bisync](/commands/rclone_bisync/)	- [Bidirectional synchronization](/bisync/) between two paths.
 * [rclone move](/commands/rclone_move/)		- Move files from source to dest.
 * [rclone delete](/commands/rclone_delete/)	- Remove the contents of path.
 * [rclone purge](/commands/rclone_purge/)	- Remove the path and all of its contents.