docs: add rcp documentation

BastilleBSD · Jan 11, 2025 · c67ab18 · c67ab18
1 parent 14d7f4a
commit c67ab18
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/chapters/subcommands/rcp.rst b/docs/chapters/subcommands/rcp.rst
@@ -0,0 +1,22 @@
+===
+rcp
+===
+
+This command allows copying files from a single jail to the host.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille rcp bastion /tmp/myfile /temp
+  [bastion]:
+  /usr/local/bastille/jails/bastion/root/tmp/myfile -> /temp/myfile
+
+Unless you see errors reported in the output the `rcp` was successful.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille rcp help
+  Usage: bastille rcp [option(s)] TARGET JAIL_PATH HOST_PATH
+    Options:
+
+    -q | --quiet          Suppress output.
+    -x | --debug          Enable debug mode.