From: Josh Stone <jistone@redhat.com>
Date: Thu, 13 Jan 2011 01:18:17 +0000 (-0800)
Subject: PR12115: Document --remote in NEWS, stap.1, and --help
X-Git-Tag: release-1.4~15
X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=6eb5c1a157e7e74419a5fa60e614af67a44bf4bd;p=systemtap.git

PR12115: Document --remote in NEWS, stap.1, and --help
---

diff --git a/NEWS b/NEWS
index ebe31106e..4795c4169 100644
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,8 @@
 * What's new in version 1.4
 
+- The experimental --remote option will run pass 5 on a given ssh host, after
+  building locally (or with --use-server) for that target.
+
 - Warning messages from the script may now be suppressed with the stap
   and/or staprun -w option.  By default, duplicate warning messages are
   suppressed (up to a certain limit).  With stap --vp 00002 and above,
diff --git a/session.cxx b/session.cxx
index eef33a3ac..1b2e0395c 100644
--- a/session.cxx
+++ b/session.cxx
@@ -377,6 +377,8 @@ systemtap_session::usage (int exitcode)
     << "   --trust-servers[=TRUST-SPEC]" << endl
     << "              add/revoke trust of specified compile-servers" << endl
 #endif
+    << "   --remote=HOSTNAME" << endl
+    << "              run pass 5 on the specified ssh host (EXPERIMENTAL)" << endl
     ;
 
   time_t now;
diff --git a/stap.1 b/stap.1
index 154aff374..68daaed38 100644
--- a/stap.1
+++ b/stap.1
@@ -385,6 +385,14 @@ Unless \fBno\-prompt\fR has been specified,
 the user will be prompted to confirm the trust to be granted or revoked before
 the operation is performed.
 
+.TP
+.BI \-\-remote " [USER@]HOSTNAME"
+Set the execution target to the specified ssh host, optionally using a username
+not matching your own.  This option may be repeated to target multiple
+execution targets.  Passes 1-4 are completed locally as normal to build the
+script, and then pass 5 will copy the module to the target and run it.
+(EXPERIMENTAL)
+
 .SH ARGUMENTS
 
 Any additional arguments on the command line are passed to the script