Merge branch '17754-federated-acct-merge'. Refs #17754.

[arvados.git] / doc / user / debugging / container-shell-access.html.textile.liquid

diff --git a/doc/user/debugging/container-shell-access.html.textile.liquid b/doc/user/debugging/container-shell-access.html.textile.liquid
index a352b33b52f03b89d845c99d7ab70630ae88fe31..91347e66f2ffb9a4f8f86dba73f98c33128905ac 100644 (file)
--- a/doc/user/debugging/container-shell-access.html.textile.liquid
+++ b/doc/user/debugging/container-shell-access.html.textile.liquid
@@ -19,7 +19,7 @@ The @arvados-client@ program can be used to connect to a container in a running
 
 h2(#syntax). Syntax
 
-The @arvados-client shell@ tool has a number of command line arguments:
+The @arvados-client shell@ tool has the following syntax:
 
 <notextile>
 <pre><code>~$ <span class="userinput">arvados-client shell -h</span>
@@ -34,12 +34,14 @@ Options:
 </code></pre>
 </notextile>
 
+The @arvados-client shell@ command calls the ssh binary on your system to make the connection. Everything after _[username@]container-uuid_ is passed through to your OpenSSH client.
+
 h2(#Examples). Examples
 
 Connect to a running container, using the container request UUID:
 
 <notextile>
-<pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-xvhdp-e6wnujfslyyqn4b</span>
+<pre><code>~$ <span class="userinput">arvados-client shell ce8i5-xvhdp-e6wnujfslyyqn4b</span>
 root@0f13dcd755fa:~#
 </code></pre>
 </notextile>
@@ -47,7 +49,7 @@ root@0f13dcd755fa:~#
 The container UUID also works:
 
 <notextile>
-<pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430</span>
+<pre><code>~$ <span class="userinput">arvados-client shell ce8i5-dz642-h1cl0sa62d4i430</span>
 root@0f13dcd755fa:~#
 </code></pre>
 </notextile>
@@ -55,7 +57,7 @@ root@0f13dcd755fa:~#
 SSH port forwarding is supported:
 
 <notextile>
-<pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
+<pre><code>~$ <span class="userinput">arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
 root@0f13dcd755fa:~# nc -l -p 80
 </code></pre>
 </notextile>
@@ -63,15 +65,14 @@ root@0f13dcd755fa:~# nc -l -p 80
 And then, connecting to port 8888 locally:
 
 <notextile>
-<pre><code>~$ <span class="userinput">nc localhost 8888</span>
-hello
+<pre><code>~$ <span class="userinput">echo hello | nc localhost 8888</span>
 </code></pre>
 </notextile>
 
 Which appears on the other end:
 
 <notextile>
-<pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
+<pre><code>~$ <span class="userinput">arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
 root@0f13dcd755fa:~# nc -l -p 80
 hello
 </code></pre>