From c67ab1879c1e8d14defd6cbc74834099452ba6c9 Mon Sep 17 00:00:00 2001 From: tschettervictor <85497460+tschettervictor@users.noreply.github.com> Date: Sat, 11 Jan 2025 16:59:41 -0700 Subject: [PATCH] docs: add rcp documentation --- docs/chapters/subcommands/rcp.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/chapters/subcommands/rcp.rst diff --git a/docs/chapters/subcommands/rcp.rst b/docs/chapters/subcommands/rcp.rst new file mode 100644 index 000000000..7b9945d7a --- /dev/null +++ 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.