Changeset 5871

Show
Ignore:
Timestamp:
09/05/10 19:14:54 (3 years ago)
Author:
luis
Message:

(Network Scanner)
- s/Umit/Umit Network Scanner
- Ajust columns (max 80 chars per line)

Location:
network-scanner/trunk/share/doc/umit/src
Files:
9 modified

Legend:

Unmodified
Added
Removed

  • network-scanner/trunk/share/doc/umit/src/comparing_results.rst

    r5632 r5871  
    2121--------------------- 
    2222 
    23 To reach the Compare Results Window, make sure that Umit is open, and then 
    24 do one of  the following: 
     23To reach the Compare Results Window, make sure that Umit Network Scanner is open,  
     24and then do one of  the following: 
    2525 
    2626   1. **Use the key-stroke** 
    … …  
    2828      * The key-stroke that shows the Compare Results Window is CTRL + D. 
    2929 
    30    2. **Single click on the Compare Results Icon in the Main Toolbar** 
    31  
    32       * The Compare Results Icon in the Main Toolbar may differ from theme 
    33         to theme, but it is always the 6th icon counting from left to right. 
    34  
    35    3. **Access from the Main Menu** 
     30   2. **Access from the Main Menu** 
    3631 
    3732      * Go to the *Main Menu* (the one on the top of the application), 
    38         File->Compare Results. 
     33        Tools->Compare Results. 
    3934 
    4035 
    … …  
    4237---------------------- 
    4338 
    44 To avoid too much user interaction, and usability problems, Umit 
     39To avoid too much user interaction, and usability problems, Umit Network Scanner 
    4540automatically make available at the *Compare Results Window* combo boxes, 
    4641the scan results currently loaded in the main interface. As you may have 
    … …  
    5247 
    5348If one or both of the scan results that you wish to compare are not loaded in 
    54 Umit's main interface, you can compare then by loading then inside the 
    55 *Compare Results Window* without the need of closing the window, loading the 
    56 results into scan tabs, and then openning the *Compare Results Window* again. 
    57 To load then directly, use the Open button that resides on the right of each 
    58 combo box. 
     49Umit Network Scanner's main interface, you can compare then by loading then  
     50inside the *Compare Results Window* without the need of closing the window,  
     51loading the results into scan tabs, and then openning the  
     52*Compare Results Window* again. To load then directly, use the Open button  
     53that resides on the right of each combo box. 
    5954 
    6055You may also want to compare results that are not saved into files, but inside 
    61 the Umit's search data base. To load those results, you'll have to load then 
    62 into scan tabs first, and then open the *Compare Results Window* to compare 
    63 them. It's a bit cumbersome, but loading then directly from the 
     56the Umit Network Scanner's search data base. To load those results, you'll  
     57have to load then into scan tabs first, and then open the *Compare Results Window*  
     58to compare them. It's a bit cumbersome, but loading then directly from the 
    6459*Compare Results Window* would implicate on creating more widgets inside 
    6560the window and making it more complex, thus lowing it's usability anyway. 
    … …  
    8479usefull comparison. 
    8580 
    86 Let's say that you have two different scans loaded in Umit, and you wish 
    87 to compare then. The first one, called *"Quick Scan on 192.168.204.128"* is 
    88 a scan result made 2 days ago, and the second one, called 
     81Let's say that you have two different scans loaded in Umit Network Scanner, and  
     82you wish to compare then. The first one, called *"Quick Scan on 192.168.204.128"*  
     83is a scan result made 2 days ago, and the second one, called 
    8984*"Regular Scan on 192.168.204.128"* is a just finished scan result. The goal 
    9085is to verify if something has changed during this 2 days, like if a service 
    … …  
    10499and at *Scan Result 2* select *"Regular Scan on 192.168.204.128"*. 
    105100In the moment you finish the selection of the results you want to compare, 
    106 Umit detects your choices and generates automatically the comparison result. 
     101Umit Network Scanner detects your choices and generates automatically  
     102the comparison result. 
    107103 
    108104   .. image:: static/comparing_results2.png 
    … …  
    110106 
    111107The *Compare Results Window* with selected results and the comparison 
    112 generated automatically by Umit. 
     108generated automatically by Umit Network Scanner. 
    113109 
    114110   .. image:: static/comparing_results3.png 
    … …  
    121117------------------ 
    122118 
    123 If you're an old Umit user, you won't be surprised with the text mode. 
    124 But maybe, if you are a new user, you will probably be questionning why 
     119If you're an old Umit Network Scanner user, you won't be surprised with the text  
     120mode. But maybe, if you are a new user, you will probably be questionning why 
    125121there is a *"Text mode"*, if you've got the *"Compare mode"*, that is easier 
    126122to read and understand. Here goes the answer: The *"Text mode"* is the first 
    … …  
    131127copied and pasted anywhere. This mode is not so complete as the 
    132128*"Compare mode"*, but it's the only one that you can save for latter analysis. 
    133 In the future, Umit will feature a report generation tool, to ease this task. 
     129In the future, Umit Network Scanner will feature a report generation tool,  
     130to ease this task. 
    134131 
    135132 
    … …  
    251248^^^^^^^^^^^^ 
    252249 
    253 There's a bug that avoids the use of this feature when Umit is been executed 
    254 with *sudo* in Linux. 
     250There's a bug that avoids the use of this feature when Umit Network Scanner is  
     251been executed with *sudo* in Linux. 

  • network-scanner/trunk/share/doc/umit/src/interface_editor.rst

    r5632 r5871  
    88 
    99   This documentation is not finished! Part or all of it's content may be 
    10    missing or inaccurate. As Umit is under constant development and 
    11    improvement, expect changes in this documentation at upcoming releases. 
     10   missing or inaccurate. As Umit Network Scanner is under constant development 
     11   and improvement, expect changes in this documentation at upcoming releases. 
    1212 
    1313 
    … …  
    1818should be able to add, edit and remove **Nmap** options. 
    1919 
    20 Profile Editor and Wizard are using XML files to load his options. Interface Editor 
    21 management this XMLs and show a graphical interface to handle it in run-time. 
     20Profile Editor and Wizard are using XML files to load his options. Interface  
     21Editor management this XMLs and show a graphical interface to handle it  
     22in run-time. 
    2223 
    2324What does it do? 
    … …  
    9192* Need Root  
    9293    
    93    If "Need Root" is able this option will be not considered if Umit is running without  
    94    Administrator level. 
     94   If "Need Root" is able this option will be not considered if Umit Network 
     95   Scanner is running without Administrator level. 
    9596 
    9697* Options + Args  
    … …  
    112113   The description of input parameters of Nmap introduced in "Args" button 
    113114 
    114 If you add a new option or delete it will be added to Undo/Redo stack and you can easier rollback changes. 
     115If you add a new option or delete it will be added to Undo/Redo stack and you  
     116can easier rollback changes. 
    115117    
    116118    
    … …  
    119121 
    120122 
    121 If a user can remove an option it can be done, just selecting the option in the list 
    122 and then press in "Delete" button. 
     123If a user can remove an option it can be done, just selecting the option in the  
     124list and then press in "Delete" button. 
    123125 
    124126 
    … …  
    129131   Interface Editor - Remove Option with Dependence 
    130132 
    131 In :ref:`Remove Option <ieditorremoveoption>` there is dependence in Profile and Wizard. 
    132 If you remove the option it will removed also from Profile Editor and Wizard. 
     133In :ref:`Remove Option <ieditorremoveoption>` there is dependence in Profile and 
     134Wizard. If you remove the option it will removed also from Profile Editor and Wizard. 
    133135 
    134136 
    … …  
    158160 
    159161 
    160 If you remove an option (just selecting, and press "Delele" or throught the tooolbar/menu) 
    161 automatically you get a voidplace. Then user will be able to exchange the option. 
    162  
    163 In each option user can put the option up or down from the others just using menu "Items" 
    164 or using the left toolbar. 
     162If you remove an option (just selecting, and press "Delele" or throught the  
     163tooolbar/menu) automatically you get a voidplace. Then user will be able to 
     164exchange the option. 
     165 
     166In each option user can put the option up or down from the others just using  
     167menu "Items" or using the left toolbar. 
    165168 
    166169*Sections* 

  • network-scanner/trunk/share/doc/umit/src/network_topology.rst

    r5632 r5871  
    1010 
    1111   This documentation is not finished! Part or all of it's content may be 
    12    missing or inaccurate. As Umit is under constant development and 
    13    improvement, expect changes in this documentation at upcoming releases. 
     12   missing or inaccurate. As Umit Network Scanner is under constant development 
     13   and improvement, expect changes in this documentation at upcoming releases. 
    1414 
    1515 

  • network-scanner/trunk/share/doc/umit/src/plugins.rst

    r5632 r5871  
    77 
    88   This documentation is not finished! Part or all of it's content may be 
    9    missing or inaccurate. As Umit is under constant development and 
    10    improvement, expect changes in this documentation at upcoming releases. 
     9   missing or inaccurate. As Umit Network Scanner is under constant development 
     10   and improvement, expect changes in this documentation at upcoming releases. 
    1111 
    1212Introduction 
    … …  
    1414 
    1515Plugins are useful to implement indipendent features that could help the user 
    16 to customize the UMIT experience. 
     16to customize the Umit Network Scanner experience. 
    1717 
    18 From the Plugin Window you could manage UMIT plugins. The window is divided in 
    19 two sections the *Extensions* and *Path* view. 
     18From the Plugin Window you could manage Umit Network Scanner plugins.  
     19The window is divided in two sections the *Extensions* and *Path* view. 
    2020 
    2121Extensions View 
    … …  
    117117Plugin Path directory, listed in the *Paths* View. 
    118118 
    119 For example on *NIX system you could do:: 
     119For example on *NIX* system you could do:: 
    120120 
    121121   $ cd ~/.umit/plugins 

  • network-scanner/trunk/share/doc/umit/src/plugins_dev.rst

    r5632 r5871  
    77 
    88   This documentation is not finished! Part or all of it's content may be 
    9    missing or inaccurate. As Umit is under constant development and 
    10    improvement, expect changes in this documentation at upcoming releases. 
     9   missing or inaccurate. As Umit Network Scanner is under constant development 
     10   and improvement, expect changes in this documentation at upcoming releases. 
    1111 
    1212Introduction 

  • network-scanner/trunk/share/doc/umit/src/profile_editor.rst

    r5632 r5871  
    88 
    99   This documentation is not finished! Part or all of it's content may be 
    10    missing or inaccurate. As Umit is under constant development and 
    11    improvement, expect changes in this documentation at upcoming releases. 
     10   missing or inaccurate. As Umit Network Scanner is under constant development 
     11   and improvement, expect changes in this documentation at upcoming releases. 
    1212 
    1313 
    … …  
    2222future.  
    2323 
    24 Since Umit Network Scanner 1.0 it was included a manager of Profiles called ProfileManager. 
     24Since Umit Network Scanner 1.0 it was included a manager of Profiles called  
     25ProfileManager. 
    2526 
    2627What does it do? 
    … …  
    5859 
    5960   * Go to the *Main Menu* (the one on the top of the application) 
    60    :menuselection:`Profile --> New Profile` 
     61    
     62    :menuselection:`Profile --> New Profile` 
    6163 
    62643. **Access from the ProfileManager** 
    … …  
    165167----------------------------- 
    166168 
    167 The *Profile Manager* is able to create, edit and delete new profiles as we explain above. 
     169The *Profile Manager* is able to create, edit and delete new profiles as we  
     170explain above. 
    168171 
    169172   .. image:: static/profile_manager.png 

  • network-scanner/trunk/share/doc/umit/src/scanning.rst

    r5632 r5871  
    77 
    88   This documentation is not finished! Part or all of it's content may be 
    9    missing or inaccurate. As Umit is under constant development and 
    10    improvement, expect changes in this documentation at upcoming releases. 
     9   missing or inaccurate. As Umit Network Scanner is under constant development 
     10   and improvement, expect changes in this documentation at upcoming releases. 
    1111 
    1212 
    … …  
    1414------------ 
    1515 
    16 Umit was designed to accomodate and run more than one scan at time. Each scan 
    17 is executed and shown inside a *Scan Tab*, which has a title and organize 
    18 every information obtained in the scan result. 
     16Umit Network Scanner was designed to accomodate and run more than one scan at  
     17time. Each scan is executed and shown inside a *Scan Tab*, which has a title  
     18and organize every information obtained in the scan result. 
    1919 
    2020The *Scan Tab* tries to facilitate your life, by making the unformations 
    … …  
    3131a boring task that gets worst when you have to do that more than once. 
    3232 
    33 An answer to your problem is Umit, that can handle this task easily, with 
    34 just a couple of clicks. 
     33An answer to your problem is Umit Network Scanner, that can handle this task  
     34easily, with just a couple of clicks. 
    3535 
    3636So, if you're wondering if you should retire the command line, I would say 
    … …  
    4545pull off your doubt about what is up or down from were you stand. 
    4646 
    47 Umit is intended to help you manage your network, by giving you a better 
    48 way to examine carefully your network peers. If your intention is to 
    49 *know* better your network, then Umit is what you need. 
     47Umit Network Scanner is intended to help you manage your network, by giving you 
     48a better way to examine carefully your network peers. If your intention is to 
     49*know* better your network, then Umit Network Scanner is what you need. 
    5050 
    5151 
    … …  
    5454 
    5555To start a scan, you need an empty *Scan Tab*. At the time you start 
    56 Umit, a new *Scan Tab* is made available, and as soon as the main interface 
    57 is shown, you can start typing the target address. If you already used this 
    58 *Scan Tab*, you can create a new one, by doing one of the following: 
     56Umit Network Scanner, a new *Scan Tab* is made available, and as soon as the  
     57main interface is shown, you can start typing the target address. If you already 
     58used this *Scan Tab*, you can create a new one, by doing one of the following: 
    5959 
    6060   1. **Use the key-stroke** 
    … …  
    7777---------------- 
    7878 
    79 By the moment you start Umit, or create a new scan tab, you can start typing 
    80 the address of the target(s) that you want to scan. Every target inserted into 
    81 the Target field is recorded and remembered in case you need it in the future. 
    82 As this field features an auto-completation, it's going to be easy the reuse of 
    83 targets. 
     79By the moment you start Umit Network Scanner, or create a new scan tab, you can  
     80start typing the address of the target(s) that you want to scan. Every target  
     81inserted into the Target field is recorded and remembered in case you need it in 
     82the future. As this field features an auto-completation, it's going to be easy  
     83the reuse of targets. 
    8484 
    8585 

  • network-scanner/trunk/share/doc/umit/src/under_the_roof.rst

    r5632 r5871  
    88 
    99   This documentation is not finished! Part or all of it's content may be 
    10    missing or inaccurate. As Umit is under constant development and 
    11    improvement, expect changes in this documentation at upcoming releases. 
     10   missing or inaccurate. As Umit Network Scanner is under constant development 
     11   and improvement, expect changes in this documentation at upcoming releases. 
    1212 
    1313 
    … …  
    1717------------------- 
    1818 
    19 Umit will always try to create a $HOME/.umit configuration directory if it 
    20 doesn't exists yet, under UNIX. Under Windows it will try to a configuration 
    21 directory named umit under user's local application data. We call this 
    22 configuration directory as UMIT_CFG_DIR. 
     19Umit Network Scanner will always try to create a $HOME/.umit configuration  
     20directory if it doesn't exists yet, under UNIX. Under Windows it will try to a  
     21configuration directory named umit under user's local application data.  
     22We call this configuration directory as UMIT_CFG_DIR. 
    2323 
    24 The steps bellow, describes how Umit is going to behave on every 
     24The steps bellow, describes how Umit Network Scanner is going to behave on every 
    2525startup in order to load the configuration files: 
    2626 
    … …  
    5151----------- 
    5252 
    53 Yes, there are easter eggs in Umit. Go find them! 
     53Yes, there are easter eggs in Umit Network Scanner. Go find them! 

  • network-scanner/trunk/share/doc/umit/src/wizard.rst

    r5870 r5871  
    99 
    1010   This documentation is not finished! Part or all of it's content may be 
    11    missing or inaccurate. As Umit is under constant development and 
    12    improvement, expect changes in this documentation at upcoming releases. 
     11   missing or inaccurate. As Umit Network Scanner is under constant development 
     12   and improvement, expect changes in this documentation at upcoming releases. 
    1313 
    1414 
    … …  
    1616------------ 
    1717 
    18 Using Umit Network Scanner user is able to choose options, arguments or make repeated scans. 
    19 Sometimes it is not a easier process. Even with Profile Editor it is not a easier task.  
    20 Command Constructor Wizard was create to help users create a customized command. 
     18Using Umit Network Scanner user is able to choose options, arguments or make  
     19repeated scans. Sometimes it is not a easier process. Even with Profile Editor  
     20it is not a easier task. Command Constructor Wizard was create to help users  
     21create a customized command. 
    2122 
    22 Using wizard available options can be enable quickly and a new profile will be create faster. 
     23Using wizard available options can be enable quickly and a new profile will be 
     24create faster. 
    2325 
    2426The wizard modes 
    2527------------------------ 
    2628 
    27 Wizard has two modes: Novice and Expert. If Expert mode is selected it will open Profile Editor. Otherwise it will give an assistance helping you creating a customized profile. 
     29Wizard has two modes: Novice and Expert. If Expert mode is selected it will open  
     30Profile Editor. Otherwise it will give an assistance helping you creating a  
     31customized profile. 
    2832