summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjasplin <qt-info@nokia.com>2009-10-10 21:25:25 +0200
committerjasplin <qt-info@nokia.com>2009-10-10 21:25:25 +0200
commita994667f9d6742e7f3cf7783d79f4c99c487f64e (patch)
treebadb559f4e9442dfe25292c75a9cec66baba2938 /doc
parent1ec4833766fff2062272f06d4bd4a02a9b8840ff (diff)
Renamed files and directories.
Diffstat (limited to 'doc')
-rw-r--r--doc/bmclient.html (renamed from doc/bmc.html)50
-rw-r--r--doc/bmproto.html (renamed from doc/bmcp.html)4
2 files changed, 27 insertions, 27 deletions
diff --git a/doc/bmc.html b/doc/bmclient.html
index c13da75..5228a36 100644
--- a/doc/bmc.html
+++ b/doc/bmclient.html
@@ -14,11 +14,11 @@ td {vertical-align:top; padding:5px}
<body>
-<h2>BMC Client Program</h2>
+<h2>BM Client Program</h2>
<h3>Overview</h3>
-The BMC client program (<code>bmc</code>) is a program that communicates with
-a BMC server via the BMC protocol (described elsewhere). The program accepts
+The BM client program (<code>bmclient</code>) is a program that communicates with
+a BM server via the BM protocol (described elsewhere). The program accepts
input via command-line arguments, environment variables, or standard input.
The program writes output (if any) to standard output or standard error.
@@ -38,28 +38,28 @@ If command-line arguments are present the program is run in <i>raw mode</i>.
In raw mode, passing <code>help</code> to the program prints out a usage summary:
<pre>
- ./bmc help
+ ./bmclient help
</pre>
<h3>Server Location</h3>
-The server location may be set via the <code>BMCSERVER</code> environment
+The server location may be set via the <code>BMSERVER</code> environment
variable, e.g.:
<pre>
- export BMCSERVER=localhost:1104
- ./bmc ...
+ export BMSERVER=localhost:1104
+ ./bmclient ...
</pre>
or
<pre>
- env BMCSERVER=localhost:1104 ... ./bmc ...
+ env BMSERVER=localhost:1104 ... ./bmclient ...
</pre>
In raw mode, the server location may also be specified by passing the
<code>-server</code> command-line option, e.g.:
<pre>
- ./bmc -server localhost:1104 ...
+ ./bmclient -server localhost:1104 ...
</pre>
The command-line option overrides the environment variable.
@@ -86,7 +86,7 @@ to the raw mode command line.
<tr>
<td>
<pre class="command">
-./bmc put results &lt;file&gt; \
+./bmclient put results &lt;file&gt; \
&lt;platform&gt; &lt;host&gt; \
&lt;git repo&gt; [&lt;git dir&gt;]
</pre>
@@ -129,7 +129,7 @@ repository).
<tr>
<td>
<pre class="command">
-./bmc get snapshots \
+./bmclient get snapshots \
&lt;test case&gt; &lt;test function&gt; \
&lt;data tag&gt; &lt;metric&gt; \
&lt;platform&gt; &lt;host&gt; \
@@ -169,7 +169,7 @@ Content-type: text/json
<tr>
<td>
<pre class="command">
-./bmc get benchmarks \
+./bmclient get benchmarks \
[-metric &lt;metric&gt;] \
[-platform &lt;platform&gt;] \
[-host &lt;host&gt;] \
@@ -223,7 +223,7 @@ Content-type: text/json
<tr>
<td>
<pre class="command">
-./bmc get metrics \
+./bmclient get metrics \
[-benchmark &lt;test case&gt; \
&lt;test function&gt; &lt;data tag&gt;] \
[-platform &lt;platform&gt;] \
@@ -233,7 +233,7 @@ Content-type: text/json
</td>
<td class="commandDescr">
Lists available metrics.
-Behaves similarly to <span class="command">./bmc get benchmarks ...</span> (see this).
+Behaves similarly to <span class="command">./bmclient get benchmarks ...</span> (see this).
</td>
<td>
<pre>
@@ -261,7 +261,7 @@ Content-type: text/json
<tr>
<td>
<pre class="command">
-./bmc get platforms \
+./bmclient get platforms \
[-benchmark &lt;test case&gt; \
&lt;test function&gt; &lt;data tag&gt;] \
[-metric &lt;metric&gt;] \
@@ -271,7 +271,7 @@ Content-type: text/json
</td>
<td class="commandDescr">
Lists available platforms.
-Behaves similarly to <span class="command">./bmc get benchmarks ...</span> (see this).
+Behaves similarly to <span class="command">./bmclient get benchmarks ...</span> (see this).
</td>
<td>
<pre>
@@ -299,7 +299,7 @@ Content-type: text/json
<tr>
<td>
<pre class="command">
-./bmc get hosts \
+./bmclient get hosts \
[-benchmark &lt;test case&gt; \
&lt;test function&gt; &lt;data tag&gt;] \
[-metric &lt;metric&gt;] \
@@ -309,7 +309,7 @@ Content-type: text/json
</td>
<td class="commandDescr">
Lists available hosts.
-Behaves similarly to <span class="command">./bmc get benchmarks ...</span> (see this).
+Behaves similarly to <span class="command">./bmclient get benchmarks ...</span> (see this).
</td>
<td>
<pre>
@@ -337,7 +337,7 @@ Content-type: text/json
<tr>
<td>
<pre class="command">
-./bmc get branches \
+./bmclient get branches \
[-benchmark &lt;test case&gt; \
&lt;test function&gt; &lt;data tag&gt;] \
[-metric &lt;metric&gt;] \
@@ -347,7 +347,7 @@ Content-type: text/json
</td>
<td class="commandDescr">
Lists available branches.
-Behaves similarly to <span class="command">./bmc get benchmarks ...</span> (see this).
+Behaves similarly to <span class="command">./bmclient get benchmarks ...</span> (see this).
</td>
<td>
<pre>
@@ -379,7 +379,7 @@ Content-type: text/json
<tr>
<td>
<pre class="command">
-./bmc get history &lt;test case&gt; \
+./bmclient get history &lt;test case&gt; \
&lt;test function&gt; &lt;data tag&gt; \
&lt;metric&gt; &lt;platform&gt; &lt;host&gt; \
&lt;git repo&gt; &lt;git branch&gt; \
@@ -571,7 +571,7 @@ Content-type: text/json
<tr>
<td>
<pre class="command">
-./bmc get value &lt;test case&gt; \
+./bmclient get value &lt;test case&gt; \
&lt;test function&gt; &lt;data tag&gt; \
&lt;metric&gt; &lt;file&gt;
</pre>
@@ -595,12 +595,12 @@ test function, data tag, and metric from the given file.
<tr>
<td>
<pre class="command">
-./bmc get server
+./bmclient get server
</pre>
</td>
<td class="commandDescr">
Prints the default server if any. This is normally the server specified in the
-BMCSERVER environment variable.
+BMSERVER environment variable.
</td>
<td>
<pre>
@@ -645,7 +645,7 @@ input using POST (rather than GET) as the HTTP request method.
<tr>
<td>
<pre class="command">
-./bmc
+./bmclient
</pre>
</td>
<td class="commandDescr">
diff --git a/doc/bmcp.html b/doc/bmproto.html
index c6bc332..41cea65 100644
--- a/doc/bmcp.html
+++ b/doc/bmproto.html
@@ -14,11 +14,11 @@ td {vertical-align:top; padding:5px}
<body>
-<h2>BMC Protocol</h2>
+<h2>BM Protocol</h2>
<h3>Overview</h3>
-The BMC protocol is a simple protocol that assumes a reliable byte channel
+The BM protocol is a simple protocol that assumes a reliable byte channel
(like TCP) between a client and a server. Requests are sent from the client to
the server. Each request is followed by a reply sent from the server to the
client.