From fb8b43dbce8bc310718614384297aeaabb9a3cbb Mon Sep 17 00:00:00 2001 From: Michael Krelin Date: Mon, 05 Jul 2004 01:53:09 +0000 Subject: initial commit into svn repository git-svn-id: http://svn.klever.net/kin/bigbrother/trunk@1 fe716a7a-6dde-0310-88d9-d003556173a8 --- (limited to 'help/bigbrother.xml') diff --git a/help/bigbrother.xml b/help/bigbrother.xml new file mode 100644 index 0000000..d83ae43 --- a/dev/null +++ b/help/bigbrother.xml @@ -0,0 +1,229 @@ + + + + About Big Brother + dedicated to Kundel +

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 add this point by specifying it's IP address or hostname and optional short description (for your information only).

+

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.

+

Every specified period of time Big Brother will send echo request to every host. And wait for response for at most specified timeout.

+

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 logged into file.

+

Your current preferences and network tree are automatically saved on Windows shutdown (unless specified otherwise) and may be autosaved every specified amount of minutes. Most recently used file is automatically loaded at Big Brother's startup unless you don't want it.

+

You can also hide Big Brother into your notify tray so that it won't occupy more than 16x16 square of your precious windows' desktop. Just click in your notify tray or select View/Main Window from menu. Click again to restore Big Brother to its full size.

+

+

Enjoy!

+ + + + + + License change and opening the source code + Made it work with Win2k and friends + Added kinwide installer + + + + Using Big Brother +

Using Big Brother consists of two parts - designing your network tree and monitoring it's activity. The latter takes no effort of yours.

+

To design the network layout is to put your hosts into Network Tree pane. To add a child host to the current just press insert or Select Brothers/Add child from menu. To add a brother of the current host select Brothers/Add brother from menu. (note: You can't add brother to the root node)

+

You may also show properties dialog box by selecting View/Host Properties menu. Properties dialog box also pops up automatically whenever you press Enter in the tree view pane.

+

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:

+
    +
  • 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.
    • +
  • In progress - checking of this host is in progress.
    • +
  • Reachable host - this host is reachable and you have no reason to worry about it.
    • +
  • Worrisome host - this host was reported as unreachable, but less than for specified retries times.
    • +
  • Unreachable host - this host is known as unreachable for a long time. Whenever the host enters or leaves this state specified actions are taken.
    • +
+

Lower pane shows a histogram of response times for a specified 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.

+

Histogram shows the Round Trip Time in the following colours:

+
    +
  • Host's response time is less than 1/3 of the specified timeout.
    • +
  • Host's response time is more than 1/3, but less then 2/3 of the specified timeout.
    • +
  • Host's response time is more than 2/3 of the specified timeout.
    • +
+ + + Preferences +

The Preferences dialog box allows you to change global system preferences which are:

+ + + + Host Properties +

You may show/hide Host Properties dialog box using this menu command

+

Host Properties dialog box consists of three tabs. See General tab, Settings tab and Action tab for further details.

+ + + Add new host (child to current) +

You can add new host into your network using this menu command. New host will be the child to current.

+ + + Autoload +

You may specify whether you want Big Brother to load most recently used file at the startup or not.

+ + + Action +

Using action tab of host properties dialog box you may specify the actions to be taken whenever host changes its state from up to down and vice versa.

+
    +
  • 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.
    • +
  • Going down - Actions to take whenever host goes down (is known as unreachable for retries times in a row). See below for details.
    • +
  • Going up - Actions to take whenever host becomes reachable after it is considered to be down.
    • +
+

Possible actions are:

+
    +
  • Play a sound - Plays a sound. You may specify a .wav file or use one of the predefined sounds which are +
      +
    • (host-up) - Default sound indicating host recovering from crash
      • +
    • (host-down) - Default sound indicating crashing host
      • +
    • (system-ok) - System sound as defined in Control Panel/Sounds 'Asterisk'
      • +
    • (system-critical) - System sound as defined in Control Panel/Sounds 'Critical Stop'
      • +
    +
    • +
  • Run custom program - Run custom program. The following special sequences are defined: +
      +
    • %h - Host name
      • +
    • %d - Host description
      • +
    • %% - % sign
      • +
    +
    • +
+ + + Main Window +

You may hide Big Brother's main window using this command. You may get the window back by clicking the in your notification tray area.

+ + + General tab +

General tab of Host Properties dialog box lets you specify the following:

+ + + + Pause +

This command lets you temporarily disable monitoring of hosts. Big Brother will just sit and wait until you let him do his work.

+ + + Settings tab +

Settings tab of Host Properties dialog box lets you specify the following:

+ + + + Delete +

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.

+ + + Add new host (brother to current) +

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)

+ + + New +

Create the whole new network tree. This command will remove all hosts you currently have.

+ + + Open +

Open previously saved network file.

+ + + Save +

Save your current network layout to disk file for future retrieval

+ + + Save as +

Save your current network layout under different name.

+ + + Exit +

Leave Big Brother. you will be prompted if you have unsaved information.

+ + + Toolbar +

Use this command to hide or show toolbar.

+ + + Status bar +

Use this command to hide or show status bar.

+ + + Adjust Splitter +

Adjust position of splitter between tree view pane and host activity pane

+ + + Help Topics +

Show help topics.

+ + + Most Recently Used Files +

The menu commands right before the Exit allows you to quickly retrieve one of the most recently used files.

+ + + Big Brother Activity indicator +

Big Brother activity indicator is a small red triangle spinning and turning to black whenever Big Brother is busy pinging hosts.

+ + + Status bar +

Sometimes you may see some useful messages in there. For instance, long descriptions of menu items whenever you are exploring the menu.

+ + + Context help +

Move mouse cursor with question mark wherever you want and get help for something you click on.

+ + + Maximize +

This option will maximize Big Brother window to full screen.

+ + + Move +

This option will let you move Big Brother window around the screen.

+ + + Size +

This option will let you resize Big Brother's window

+ + + Restore +

You option may use this to restore Big Brother's window to its original size after you've maximized it.

+ + + Close +

This option does about the same as the Exit menu command does.

+ + + Add new host +

You may add new hosts for monitoring in two ways - by adding it as a child or as a brother to current one.

+ + +

Tree view pane:

+
    +
  • Network - no particular host specified.
    • +
  • In progress - host is being checked.
    • +
  • Reachable host - host is reachable.
    • +
  • Worrisome host - host is dying.
    • +
  • Unreachable host - host is unreachable.
    • +
+

Activity pane:

+
    +
  • Good response time
    • +
  • Average response time
    • +
  • Critical response time
    • +
+ + -- cgit v0.9.0.2