Add initial implementation of --ssh option to connect to novaboot-shell

[novaboot.git] / README.pod

diff --git a/README.pod b/README.pod
index 83ea88ea6cd63fd0e3957cd5373358f4c3e7b542..f686d8b912327f8a47d91c6d7b225a3054708334 100644 (file)
--- a/README.pod
+++ b/README.pod
@@ -193,6 +193,18 @@ When this option is not given, novaboot tries to determine the target
 to use from either B<NOVABOOT_TARGET> environment variable or
 B<$default_target> configuration file variable.
 
+=item --ssh=I<user@hostname>
+
+Configures novaboot to control the target via C<novaboot-shell>
+running remotely via SSH.
+
+Using this option is the same as specifying B<--remote-cmd>,
+B<--remote-expect>, B<--server> B<--rsync-flags>, B<--prefix> and
+B<--reset-cmd> manually in a way compatible with V<novaboot-shell>.
+
+Currently, this in an initial experimental implementation. We plan to
+change/extend this feature soon!
+
 =back
 
 =head2 Script preprocessing phase
@@ -519,8 +531,8 @@ B<--iprelay>, B<--reset-cmd> and B<--reset-send>.
 =item --on, --off
 
 Switch on/off the target machine and exit. The script (if any) is
-completely ignored. Currently, it works only with B<--iprelay> or
-B<--amt>.
+completely ignored. Currently, it works only with the following
+options: B<--iprelay>, B<--amt>, B<--ssh>.
 
 =item -Q, --qemu[=I<qemu-binary>]