botsense  3.2.0
RoadNarrows Client-Server Proxied Services Framework
man_bsunittest.doxy
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // Package: BotSense
4 //
5 // File: man_bsunittest.doxy
6 //
7 // $LastChangedDate: 2012-02-14 12:39:13 -0700 (Tue, 14 Feb 2012) $
8 // $Rev: 1801 $
9 //
10 // Description:
11 // This file contains the doxygen directives to generate the standard
12 // man pages for the bsLoadTest client.
13 //
14 ////////////////////////////////////////////////////////////////////////////////
15 
16 /*! \file */
17 
18 /*!
19  * \ingroup example_ut
20  * \defgroup man_bsunittest bsUnitTest Man Page (TBW)
21 
22 \par Name:
23 bsUnitTest - \h_botsense unit tester client.
24 
25 \par Synopsis:
26 <tt>
27 bsUnitTest [OPTIONS]
28 \n
29 bsUnitTest --version\n
30 bsUnitTest --help
31 </tt>
32 
33 \par Description:
34 The \h_botsense <b>bsUnitTest</b> application unit test...
35 
36 \par Options:
37 Mandatory arguments to long options are also mandatory for short options.
38 \htmlonly
39 <table class="rnr-opts">
40 <tr><td class="rnr-opts-grp">Tests</td></tr>
41 <tr><td class="rnr-opts-opt">
42  -p, --proxy=<em>addr</em>[:<em>port</em>
43 </td></tr>
44 <tr><td>
45 Proxy Server's network address. The format of the address can be either a
46 network hostname or a dotted IP address number. If port is not
47 specfied, then the default port 9195 is used.
48 <br>
49 DEFAULT: <tt>localhost</tt>
50 </td></tr>
51 
52 
53 <tr><td class="rnr-opts-grp">Logging</td></tr>
54 <tr><td class="rnr-opts-opt">
55  -l <em>level</em>, --log=<em>level</em>
56 </td></tr>
57 <tr><td>
58  Set logging threshold level. All logging events
59  with priority &le; <em>level</em> will be logged. All
60  others will be ignored. Error events are
61  always logged. The <em>level</em> is one of:<br>
62  <table class="rnr-opts" style="text-align:left">
63  <tr>
64  <td>'off' or 0</td>
65  <td>Disable all logging.</td>
66  </tr>
67  <tr>
68  <td>'error' or 1</td>
69  <td>Enable error logging.</td>
70  </tr>
71  <tr>
72  <td>'diag1' or 2</td>
73  <td>Enable diagnostics 1 logging.</td>
74  </tr>
75  <tr>
76  <td>'diag2' or 3</td>
77  <td>Enable diagnostics 2 logging.</td>
78  </tr>
79  <tr>
80  <td>'diag3' or 4</td>
81  <td>Enable diagnostics 3 logging.<br>
82  The libSkewlZone library logs at this level</td>
83  </tr>
84  <tr>
85  <td>'diag4' or 5</td>
86  <td>Enable diagnostics 4 logging.</td>
87  </tr>
88  <tr>
89  <td>'diag5' or 6</td>
90  <td>Enable diagnostics 5 logging.</td>
91  </tr>
92  <tr>
93  <td>&gt;6</td>
94  <td>Enable user-defined logging.</td>
95  </tr>
96  </table>
97  DEFAULT: off
98 </td></tr>
99 <tr><td class="rnr-opts-opt">
100  --logfile=<em>file</em>
101 </td></tr>
102 <tr><td>
103  Set log output file to <em>file</em>.
104  Special <em>file</em> names are:
105  <table class="rnr-opts" style="text-align:left">
106  <tr>
107  <td>'stderr'</td>
108  <td>log to standard error.</td>
109  </tr>
110  <tr>
111  <td>'stdout'</td>
112  <td>log to standard output.</td>
113  </tr>
114  </table>
115  DEFAULT: stderr
116 </td></tr>
117 
118 <tr><td class="rnr-opts-grp">Information</td></tr>
119 <tr><td class="rnr-opts-opt">
120  --help
121 </td></tr>
122 <tr><td>
123  Display command help and exit.
124 </td></tr>
125 <tr><td class="rnr-opts-opt">
126  --version
127 </td></tr>
128 <tr><td>
129  Output version information and exit.
130 </td></tr>
131 </table>
132 \endhtmlonly
133 
134 \par Examples:
135 \htmlonly
136 <pre class="fragment"><div class="fragment"><span
137 class="comment"># Example
138 # TBW
139 $
140 $ bsUnitTest --log=diag1
141 
142 ...
143 $
144 </div></pre>
145 \endhtmlonly
146 
147  * \{
148  */
149 
150 /*! \} */