summaryrefslogtreecommitdiffabout
path: root/help/bigbrother.rtf
Unidiff
Diffstat (limited to 'help/bigbrother.rtf') (more/less context) (ignore whitespace changes)
-rw-r--r--help/bigbrother.rtf295
1 files changed, 295 insertions, 0 deletions
diff --git a/help/bigbrother.rtf b/help/bigbrother.rtf
new file mode 100644
index 0000000..eb128ac
--- a/dev/null
+++ b/help/bigbrother.rtf
@@ -0,0 +1,295 @@
1{\rtf1\ansi
2@{\footnote
3THIS FILE WAS AUTOMATICALLY GENERATED FROM XML DOCUMENT.
4DO NOT MODIFY THIS FILE DIRECTLY. EDIT XML DOCUMENT INSTEAD
5}
6{\fonttbl{\f0\froman Times New Roman;}{\f1\fswiss Arial;}{\f3\froman Symbol;}}{\colortbl;
7 \red0\green0\blue0;\red0\green0\blue255;\red0\green255\blue255;\red0\green255\blue0;
8 \red255\green0\blue255;\red255\green0\blue0;\red255\green255\blue0;\red255\green255\blue255;
9 \red0\green0\blue128;\red0\green128\blue128;\red0\green128\blue0;\red128\green0\blue128;
10 \red128\green0\blue0;\red128\green128\blue0;\red128\green128\blue128;\red192\green192\blue192;}
11
12\pard\plain\keepn
13#{\footnote About}
14${\footnote About Big Brother}
15K{\footnote about}
16{ \f1\fs18\b\sb120 About {\b Big Brother}}
17\par\sa120\sb120\qr\f1\fs16 dedicated to Kundel
18\par\sa120\sb120\qj\pard \f1\fs18\sb120 {\b Big Brother} is a program designed to monitor your IP-network activities. it gives you a comprehensive picture of what happened to any point on the Net that you put in. Just {\uldb add}{\v Add} this point by specifying it's IP address or hostname and optional short description (for your information only).
19\par\sa120\sb120\qj\pard \f1\fs18\sb120 The hosts are organized into a hierarchical tree so that you may configure your network picture according to your needs and imagination. Most of the father host properties are inherited by his children unless you wish to specify child's settings explicitly.
20\par\sa120\sb120\qj\pard \f1\fs18\sb120 Every specified period of time {\b Big Brother} will send echo request to every host. And wait for response for at most specified {\uldb timeout}{\v timeOutHIDD_PROPS_SETTINGS}.
21\par\sa120\sb120\qj\pard \f1\fs18\sb120 Results are presented in a graphical form in the lower pane. Each line of the lower window is related to specific host which is shown on the tooltip when you move your mouse over the graphics. Host activities are also {\uldb logged into file}{\v fileHIDD_PREFS}.
22\par\sa120\sb120\qj\pard \f1\fs18\sb120 Your current {\uldb preferences}{\v HIDD_PREFS} and network tree are automatically saved on Windows shutdown (unless specified otherwise) and may be {\uldb autosaved}{\v autosaveHIDD_PREFS} every specified amount of minutes. Most recently used {\uldb file}{\v MRUFile} is {\uldb automatically loaded}{\v HID_FILE_AUTOLOAD} at {\b Big Brother}'s startup unless you don't want it.
23\par\sa120\sb120\qj\pard \f1\fs18\sb120 You can also hide {\b Big Brother} into your notify tray so that it won't occupy more than 16x16 square of your precious windows' desktop. Just click \{bmct bbullet.bmp\} in your notify tray or select {\uldb View/Main Window}{\v HID_VIEW_MAINWINDOW} from menu. Click \{bmct bbullet.bmp\} again to restore {\b Big Brother} to its full size.
24\par\sa120\sb120\qj\pard \f1\fs18\sb120
25\par\sa120\sb120\qj\pard \f1\fs18\sb120 {\b {\i Enjoy!}}
26{
27\par\pard\plain\sb360\sa120 \f1\fs16 Copyright (c) 1996, 2002 {\uldb\cf0 Klever Group (http://www.klever.net/)}{\v %!ExecFile("http://www.klever.net/")}
28\par\qj\sb120\sa120Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
29\par The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
30\par \sa360 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31}
32\par \sa0\sb120\ql \f1\fs16 Author: {\b\uldb\cf11 Michael Krelin ({\i hacker@klever.net})}{\v %!ExecFile("mailto:hacker@klever.net")}
33\par \sa0\sb0 Fan mail send to {\i\uldb gefilte@klever.net}{\v %!ExecFile("mailto:gefilte@klever.net")}
34\page
35
36\pard\plain
37#{\footnote News}
38${\footnote What's New}
39\par\pard\plain\f1\fs24\qc\cf2\b 1.5 - August 19th, 2002
40\par\pard\plain\fi0\li0\f1\fs18 \bullet License change and opening the source code
41\par\pard\plain\fi0\li0\f1\fs18 \bullet Made it work with Win2k and friends
42\par\pard\plain\fi0\li0\f1\fs18 \bullet Added kinwide installer
43\page
44
45\pard\plain\keepn
46#{\footnote Using}
47${\footnote Using Big Brother}
48{ \f1\fs18\b\sb120 Using {\b Big Brother}}
49\par\sa120\sb120\qj\pard \f1\fs18\sb120 Using {\b Big Brother} consists of two parts - designing your network tree and monitoring it's activity. The latter takes no effort of yours.
50\par\sa120\sb120\qj\pard \f1\fs18\sb120 To design the network layout is to put your hosts into Network Tree pane. To {\uldb add a child host}{\v HID_BROTHERS_NEW} to the current just press insert or Select Brothers/Add child from menu. To {\uldb add a brother}{\v HID_BROTHERS_ADDBROTHER} of the current host select Brothers/Add brother from menu. (note: You can't add brother to the root node)
51\par\sa120\sb120\qj\pard \f1\fs18\sb120 You may also show {\uldb properties}{\v HostProps} dialog box by selecting View/Host Properties menu. {\uldb Properties}{\v HostProps} dialog box also pops up automatically whenever you press {\b Enter} in the tree view pane.
52\par\sa120\sb120\qj\pard \f1\fs18\sb120 Monitoring your network activities is even easier. You just relax and watch the screen (or listen to your speakers if you have ones). Network activities are reflected using the lower host activity pane and icons in the tree view. The possible states of the host are:\pard
53\par \fi0\li0 \bullet \{bmct IDI_NOHOST.bmp\}{\b Network} - you haven't specified host name or ip address for this host. The only reason that makes sense is that you probably want to use this node as a father for family of hosts.
54\par \fi0\li0 \bullet \{bmct IDI_PINGING.bmp\}{\b In progress} - checking of this host is in progress.
55\par \fi0\li0 \bullet \{bmct IDI_HOST.bmp\}{\b Reachable host} - this host is reachable and you have no reason to worry about it.
56\par \fi0\li0 \bullet \{bmct IDI_GOINGDOWN.bmp\}{\b Worrisome host} - this host was reported as unreachable, but less than for specified {\uldb retries}{\v HIDD_PROPS_SETTINGS} times.
57\par \fi0\li0 \bullet \{bmct IDI_HOSTDOWN.bmp\}{\b Unreachable host} - this host is known as unreachable for a long time. Whenever the host enters or leaves this state specified {\uldb actions}{\v HIDD_PROPS_ACTION} are taken.\pard
58\par\sa120\sb120\qj\pard \f1\fs18\sb120 Lower pane shows a histogram of response times for a {\uldb specified}{\v logLengthHIDD_PREFS} amount of time. Histograms are shown for current host and it's descendants. Hidden (collapsed) children are not shown in activity pane. When you move your mouse over histogram tooltip shows the host name and host address for the corresponding host. If you also hold left mouse button or Ctrl key it will also show you the time corresponding to the point you point at. If you hold Shift key it will also show the Round Trip Time.
59\par\sa120\sb120\qj\pard \f1\fs18\sb120 Histogram shows the Round Trip Time in the following colours:\pard
60\par \fi0\li0 \bullet \{bmct green.bmp\} Host's response time is less than 1/3 of the {\uldb specified}{\v timeOutHIDD_PROPS_SETTINGS} timeout.
61\par \fi0\li0 \bullet \{bmct yellow.bmp\} Host's response time is more than 1/3, but less then 2/3 of the {\uldb specified}{\v timeOutHIDD_PROPS_SETTINGS} timeout.
62\par \fi0\li0 \bullet \{bmct red.bmp\} Host's response time is more than 2/3 of the {\uldb specified}{\v timeOutHIDD_PROPS_SETTINGS} timeout.\pard
63\page
64
65\pard\plain\keepn
66#{\footnote HIDD_PREFS}
67${\footnote Preferences}
68{ \f1\fs18\b\sb120 Preferences}
69\par\sa120\sb120\qj\pard \f1\fs18\sb120 The Preferences dialog box allows you to change global system preferences which are:\pard
70\par \fi0\li0 \bullet {\b On windows shutdown save without confirmation} - you may specify how does {\b Big Brother} act on windows shutdown, whether to save current tree without a confirmation or not.
71\par \fi0\li0 \bullet {#{\footnote autosaveHIDD_PREFS}}Autosave - the interval at wich {\b Big Brother} will save current tree automatically. Specify 0 if you don't want to use this feature.
72\par \fi0\li0 \bullet Ping data packet size - the size of echo request packet in bytes.
73\par \fi0\li0 \bullet Ping .. hosts simultaneously - number of hosts to ping at a time. If you have a big network to monitor and have a slow computer or connection, you may want to limit number of hosts to ping simultaneously.
74\par \fi0\li0 \bullet {#{\footnote fileHIDD_PREFS}}Log to file - Here is where you specify the name of the file to log hosts activities to.
75\par \fi0\li0 \bullet {#{\footnote logLengthHIDD_PREFS}}Show last .. minutes in activity pane - This is the time length of your graphical pane window.
76\par \fi0\li0 \bullet {#{\footnote storeActivityHIDD_PREFS}}Store activity pane data - This lets you specify where to store activity pane data when saving file or not.\pard
77\page
78
79\pard\plain\keepn
80#{\footnote HID_VIEW_HOSTPROPERTIES}
81{ \f1\fs18\b\sb120 Host Properties}
82\par\sa120\sb120\qj\pard \f1\fs18\sb120 You may show/hide Host Properties dialog box using this menu command
83\par\sa120\sb120\qj\pard \f1\fs18\sb120 {#{\footnote HostProps}}Host Properties dialog box consists of three tabs. See {\uldb General tab}{\v HIDD_PROPS_GENERAL}, {\uldb Settings tab}{\v HIDD_PROPS_SETTINGS} and {\uldb Action tab}{\v HIDD_PROPS_ACTION} for further details.
84\page
85
86\pard\plain\keepn
87#{\footnote HID_BROTHERS_NEW}
88{ \f1\fs18\b\sb120 Add new host (child to current)}
89\par\sa120\sb120\qj\pard \f1\fs18\sb120 You can add new host into your network using this menu command. New host will be the child to current.
90\page
91
92\pard\plain\keepn
93#{\footnote HID_FILE_AUTOLOAD}
94{ \f1\fs18\b\sb120 Autoload}
95\par\sa120\sb120\qj\pard \f1\fs18\sb120 You may specify whether you want Big Brother to load most recently used file at the startup or not.
96\page
97
98\pard\plain\keepn
99#{\footnote HIDD_PROPS_ACTION}
100${\footnote Action tab}
101{ \f1\fs18\b\sb120 Action}
102\par\sa120\sb120\qj\pard \f1\fs18\sb120 Using action tab of {\uldb host properties}{\v HostProps} dialog box you may specify the actions to be taken whenever host changes its state from up to down and vice versa.\pard
103\par \fi0\li0 \bullet Override action - You may specify if you want this host to specify some specific actions to take or if you want it to act as it's parent does.
104\par \fi0\li0 \bullet Going down - Actions to take whenever host goes down (is known as unreachable for {\uldb retries}{\v retriesHIDD_PROPS_SETTINGS} times in a row). See {\uldb below}{\v Action} for details.
105\par \fi0\li0 \bullet Going up - Actions to take whenever host becomes reachable after it is considered to be down.\pard
106\par\sa120\sb120\qj\pard \f1\fs18\sb120 {#{\footnote Action}}Possible actions are:\pard
107\par \fi0\li0 \bullet Play a sound - Plays a sound. You may specify a .wav file or use one of the predefined sounds which are
108 \pard
109\par \fi0\li0 \bullet (host-up) - Default sound indicating host recovering from crash
110\par \fi0\li0 \bullet (host-down) - Default sound indicating crashing host
111\par \fi0\li0 \bullet (system-ok) - System sound as defined in Control Panel/Sounds 'Asterisk'
112\par \fi0\li0 \bullet (system-critical) - System sound as defined in Control Panel/Sounds 'Critical Stop'\pard
113\par \fi0\li0 \bullet Run custom program - Run custom program. The following special sequences are defined:
114 \pard
115\par \fi0\li0 \bullet %h - Host name
116\par \fi0\li0 \bullet %d - Host description
117\par \fi0\li0 \bullet %% - % sign\pard\pard
118\page
119
120\pard\plain\keepn
121#{\footnote HID_VIEW_MAINWINDOW}
122{ \f1\fs18\b\sb120 Main Window}
123\par\sa120\sb120\qj\pard \f1\fs18\sb120 You may hide {\b Big Brother}'s main window using this command. You may get the window back by clicking the \{bmct bbullet.bmp\} in your notification tray area.
124\page
125
126\pard\plain\keepn
127#{\footnote HIDD_PROPS_GENERAL}
128${\footnote General tab}
129{ \f1\fs18\b\sb120 General tab}
130\par\sa120\sb120\qj\pard \f1\fs18\sb120 General tab of {\uldb Host Properties}{\v HostProps} dialog box lets you specify the following:\pard
131\par \fi0\li0 \bullet Host - either host name or ip address of host you want to monitor.
132\par \fi0\li0 \bullet Description - a short description of the host. The name you want to refer to this host by in the future.
133\par \fi0\li0 \bullet Log Activity - You may specify if you do or don't want to log changes of this host's state into {\uldb file}{\v fileHIDD_PREFS}.\pard
134\page
135
136\pard\plain\keepn
137#{\footnote HID_FILE_PAUSE}
138{ \f1\fs18\b\sb120 Pause}
139\par\sa120\sb120\qj\pard \f1\fs18\sb120 This command lets you temporarily disable monitoring of hosts. {\b Big Brother} will just sit and wait until you let him do his work.
140\page
141
142\pard\plain\keepn
143#{\footnote HIDD_PROPS_SETTINGS}
144${\footnote Settings tab}
145{ \f1\fs18\b\sb120 Settings tab}
146\par\sa120\sb120\qj\pard \f1\fs18\sb120 Settings tab of {\uldb Host Properties}{\v HostProps} dialog box lets you specify the following:\pard
147\par \fi0\li0 \bullet Ping intervals - check this if you want to specify intervals for this host explicitly. If you don't - this host will use parent's settings. You can't uncheck this for root node.
148 \pard
149\par \fi0\li0 \bullet When the host is known as reachable - time to wait until next ping if the last ping succeeded.
150\par \fi0\li0 \bullet When the host is known as unreachable - time to wait until next ping If the last ping failed.\pard
151\par \fi0\li0 \bullet {#{\footnote timeOutHIDD_PROPS_SETTINGS}}Maximum ping reply timeout - amount of milliseconds to wait for echo reply.
152\par \fi0\li0 \bullet {#{\footnote retriesHIDD_PROPS_SETTINGS}}Maximum retries count - number of failed pings before Big Brother considers the host is down.\pard
153\page
154
155\pard\plain\keepn
156#{\footnote HID_BROTHERS_DELETE}
157{ \f1\fs18\b\sb120 Delete}
158\par\sa120\sb120\qj\pard \f1\fs18\sb120 Use this feature to remove current host and all of its children. You can't remove the root node, although you may remove all hosts but root using this command.
159\page
160
161\pard\plain\keepn
162#{\footnote HID_BROTHERS_ADDBROTHER}
163{ \f1\fs18\b\sb120 Add new host (brother to current)}
164\par\sa120\sb120\qj\pard \f1\fs18\sb120 You can add new host into your network using this menu command. New host will be a brother to current. (note: You can't add brother to the root node)
165\page
166
167\pard\plain\keepn
168#{\footnote HID_FILE_NEW}
169{ \f1\fs18\b\sb120 New}
170\par\sa120\sb120\qj\pard \f1\fs18\sb120 Create the whole new network tree. This command will remove all hosts you currently have.
171\page
172
173\pard\plain\keepn
174#{\footnote HID_FILE_OPEN}
175{ \f1\fs18\b\sb120 Open}
176\par\sa120\sb120\qj\pard \f1\fs18\sb120 Open previously {\uldb saved}{\v HID_FILE_SAVE} network file.
177\page
178
179\pard\plain\keepn
180#{\footnote HID_FILE_SAVE}
181{ \f1\fs18\b\sb120 Save}
182\par\sa120\sb120\qj\pard \f1\fs18\sb120 Save your current network layout to disk file for future {\uldb retrieval}{\v HID_FILE_OPEN}
183\page
184
185\pard\plain\keepn
186#{\footnote HID_FILE_SAVE_AS}
187{ \f1\fs18\b\sb120 Save as}
188\par\sa120\sb120\qj\pard \f1\fs18\sb120 Save your current network layout under different name.
189\page
190
191\pard\plain\keepn
192#{\footnote HID_APP_EXIT}
193{ \f1\fs18\b\sb120 Exit}
194\par\sa120\sb120\qj\pard \f1\fs18\sb120 Leave {\b Big Brother}. you will be prompted if you have unsaved information.
195\page
196
197\pard\plain\keepn
198#{\footnote HID_VIEW_TOOLBAR}
199{ \f1\fs18\b\sb120 Toolbar}
200\par\sa120\sb120\qj\pard \f1\fs18\sb120 Use this command to hide or show toolbar.
201\page
202
203\pard\plain\keepn
204#{\footnote HID_VIEW_STATUS_BAR}
205{ \f1\fs18\b\sb120 Status bar}
206\par\sa120\sb120\qj\pard \f1\fs18\sb120 Use this command to hide or show status bar.
207\page
208
209\pard\plain\keepn
210#{\footnote HID_WINDOW_SPLIT}
211{ \f1\fs18\b\sb120 Adjust Splitter}
212\par\sa120\sb120\qj\pard \f1\fs18\sb120 Adjust position of splitter between tree view pane and host activity pane
213\page
214
215\pard\plain\keepn
216#{\footnote HID_HELP_FINDER}
217{ \f1\fs18\b\sb120 Help Topics}
218\par\sa120\sb120\qj\pard \f1\fs18\sb120 Show help topics.
219\page
220
221\pard\plain\keepn
222#{\footnote MRUFile}
223{ \f1\fs18\b\sb120 Most Recently Used Files}
224\par\sa120\sb120\qj\pard \f1\fs18\sb120 The menu commands right before the Exit allows you to quickly retrieve one of the most recently used files.
225\page
226
227\pard\plain\keepn
228#{\footnote HID_INDICATOR_PINGBAR}
229{ \f1\fs18\b\sb120 {\b Big Brother} Activity indicator}
230\par\sa120\sb120\qj\pard \f1\fs18\sb120 {\b Big Brother} activity indicator is a small red triangle spinning and turning to black whenever Big Brother is busy pinging hosts.
231\page
232
233\pard\plain\keepn
234#{\footnote AFX_HIDW_STATUS_BAR}
235{ \f1\fs18\b\sb120 Status bar}
236\par\sa120\sb120\qj\pard \f1\fs18\sb120 Sometimes you may see some useful messages in there. For instance, long descriptions of menu items whenever you are exploring the menu.
237\page
238
239\pard\plain\keepn
240#{\footnote HID_CONTEXT_HELP}
241{ \f1\fs18\b\sb120 Context help}
242\par\sa120\sb120\qj\pard \f1\fs18\sb120 Move mouse cursor with question mark wherever you want and get help for something you click on.
243\page
244
245\pard\plain\keepn
246#{\footnote HID_SC_MAXIMIZE}
247{ \f1\fs18\b\sb120 Maximize}
248\par\sa120\sb120\qj\pard \f1\fs18\sb120 This option will maximize {\b Big Brother} window to full screen.
249\page
250
251\pard\plain\keepn
252#{\footnote HID_SC_MOVE}
253{ \f1\fs18\b\sb120 Move}
254\par\sa120\sb120\qj\pard \f1\fs18\sb120 This option will let you move {\b Big Brother} window around the screen.
255\page
256
257\pard\plain\keepn
258#{\footnote HID_SC_SIZE}
259{ \f1\fs18\b\sb120 Size}
260\par\sa120\sb120\qj\pard \f1\fs18\sb120 This option will let you resize {\b Big Brother}'s window
261\page
262
263\pard\plain\keepn
264#{\footnote HID_SC_RESTORE}
265{ \f1\fs18\b\sb120 Restore}
266\par\sa120\sb120\qj\pard \f1\fs18\sb120 You option may use this to restore {\b Big Brother}'s window to its original size after you've maximized it.
267\page
268
269\pard\plain\keepn
270#{\footnote HID_SC_CLOSE}
271{ \f1\fs18\b\sb120 Close}
272\par\sa120\sb120\qj\pard \f1\fs18\sb120 This option does about the same as the {\uldb Exit}{\v HID_APP_EXIT} menu command does.
273\page
274
275\pard\plain\keepn
276#{\footnote Add}
277${\footnote Add new host}
278{ \f1\fs18\b\sb120 Add new host}
279\par\sa120\sb120\qj\pard \f1\fs18\sb120 You may add new hosts for monitoring in two ways - by adding it {\uldb as a child}{\v HID_BROTHERS_NEW} or {\uldb as a brother}{\v HID_BROTHERS_ADDBROTHER} to current one.
280\page
281
282\pard\plain
283#{\footnote HID_HELP_LEGEND}
284\par\sa120\sb120\qj\pard \f1\fs18\sb120 Tree view pane:\pard
285\par \fi0\li0 \bullet \{bmct IDI_NOHOST.bmp\} Network - no particular host specified.
286\par \fi0\li0 \bullet \{bmct IDI_PINGING.bmp\} In progress - host is being checked.
287\par \fi0\li0 \bullet \{bmct IDI_HOST.bmp\} Reachable host - host is reachable.
288\par \fi0\li0 \bullet \{bmct IDI_GOINGDOWN.bmp\} Worrisome host - host is dying.
289\par \fi0\li0 \bullet \{bmct IDI_HOSTDOWN.bmp\} Unreachable host - host is unreachable.\pard
290\par\sa120\sb120\qj\pard \f1\fs18\sb120 Activity pane:\pard
291\par \fi0\li0 \bullet \{bmct green.bmp\} Good response time
292\par \fi0\li0 \bullet \{bmct yellow.bmp\} Average response time
293\par \fi0\li0 \bullet \{bmct red.bmp\} Critical response time\pard
294\page
295} \ No newline at end of file