Changeset 4321

Show
Ignore:
Timestamp:
03/08/09 11:35:04 (4 years ago)
Author:
luis
Message:

Convert Profile Editor Documentation to RST format

Location:
branch/sphinxdoc
Files:
1 removed
1 modified
2 moved

Legend:

Unmodified
Added
Removed

  • branch/sphinxdoc/src/index.rst

    r4316 r4321  
    1616   nse_facilitator.rst 
    1717   under_the_roof.rst 
     18   profile_editor.rst 

  • branch/sphinxdoc/src/profile_editor.rst

    r3278 r4321  
    1 <?xml version="1.0"?> 
    2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook v4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 
    3 <article> 
    4   <artheader> 
    5     <title>Profile Editor</title> 
    6     <author> 
    7       <firstname>Adriano</firstname> 
    8       <surname>Marques</surname> 
    9       <copyright> 
    10         <year>2006</year> 
    11         <holder>Adriano Monteiro Marques</holder> 
    12       </copyright> 
    13     </author> 
    14   </artheader> 
     1Profile Editor 
     2================== 
    153 
    16   <section> 
    17     <title>Warning</title> 
    18     <para> 
    19       This documentation is not finished! Part or all of it's content may be missing  
    20       or inaccurate. As Umit is under constant development and improvement, expect 
    21       changes in this documentation at upcoming releases. 
    22     </para> 
    23   </section> 
     4.. sectionauthor:: Adriano Monteiro Marques 
    245 
    25   <section> 
    26     <title>Introduction</title> 
    27     <para>What is the profile editor? 
     6.. warning:: 
     7 
     8   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. 
     11 
     12 
     13Introduction 
     14------------------- 
     15 
     16What is the profile editor? 
     17~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    2818   
    29     Using <application>Umit</application> it's normal when you can use the same arguments or make some scans 
    30     and sometimes it's not easy to search for the same options of nmap again. 
     19Using **Umit** it's normal when you can use the same arguments or make some scans 
     20and sometimes it's not easy to search for the same options of nmap again. 
    3121     
     22What do it does? 
     23~~~~~~~~~~~~~~~~~~ 
     24   
     25Profile Editor is able to create, copy and delele profiles. With it  
     26you should be able to save the nmap arguments and run scans with some paramenters in the  
     27future. 
    3228     
    33     </para> 
    34     <para>What do it does? 
    35    
    36     Profile Editor is able to create, copy and delele profiles. With it  
    37     you should be able to save the nmap arguments and run scans with some paramenters in the  
    38     future. 
     29The customization advantage: It's easy to call a Profile.  
     30In the tab scan you only choose the target, and select a Profile. It 
     31will define automatically the Nmap parameters.  
     32 
     33The profile editor modes 
    3934     
    40     </para> 
    41     <para> 
    42     The customization advantage: It's easy to call a Profile.  
    43     In the tab scan you only choose the target, and select a Profile. It 
    44     will define automatically the <application>Nmap</application>'s parameters.  
    45     </para> 
    46   </section> 
     35New profile: 
     36It's easy to create a new profile, you can define all **Nmap** parameters and  
     37save you a suggestive name. 
    4738 
    48   <section> 
    49     <title>The profile editor modes</title> 
    50     <para> 
    51     New profile: 
    52     It's easy to create a new profile, you can define all <application>Nmap 
    53     </application> parameters and  
    54     save you a suggestive name. 
    55     </para> 
    56     <para> 
    57     Edit profile 
    58     If you sometimes want to change the paramenters of profile, you should be use 
    59     edit of profiles and add, or remove the parameters, checking it on the boxes. 
    60     </para> 
    61   </section> 
     39Edit profile 
     40If you sometimes want to change the paramenters of profile, you should be use 
     41edit of profiles and add, or remove the parameters, checking it on the boxes. 
     42     
    6243 
    63   <section> 
    64     <title>Creating a simple scan profile</title> 
    65     <para> 
    66         
    67     <screenshot> 
    68       <graphic fileref="screenshots/profile_editor_1.png" align="center"/> 
    69     </screenshot> 
    70    Screenshot above it's the Profile Editor. 
    71     </para> 
    72     <procedure> 
    73       <title>Use the key-stroke</title> 
    74         <step>The key-stroke that creates a new Profile is <accel>CTRL + P</accel>.</step> 
    75     </procedure>  
     44Creating a simple scan profile 
     45------------------------------------ 
     46 
     47   .. image:: static/profile_editor_1.png 
     48      :align: center        
     49    
     50Screenshot above it's the Profile Editor. 
     51 
     52Use the key-stroke 
     53The key-stroke that creates a new Profile is CTRL + P 
    7654     
    77     <procedure> 
    78       <title>Acces from the Main Menu</title> 
    79       <step>Go to the <emphasis>Main Menu</emphasis> (the one on the top of the application), 
    80       <guimenu>Profile</guimenu>-&gt;<guimenuitem>New Profile</guimenuitem>.</step> 
    81     </procedure> 
     55Acces from the Main Menu 
     56~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    8257 
    83    
    84     <para> 
     58Go to the **Main Menu** (the one on the top of the application), 
     59*Profile*  ; New Profile 
    8560     
    86     The profile descriptions (name, hint, description, etc.) 
    87     There are some fields to fill about a Profile. It's mandatory fill the  
    88     name.  
     61The profile descriptions (name, hint, description, etc.) 
     62There are some fields to fill about a Profile. It's mandatory fill the  
     63name.  
    8964 
    90     </para> 
    91    <para> 
    92    Name: It is the name that appears on combo box of <emphasis> 
    93    Scan Tab 
    94    </emphasis> 
    95    </para> 
     65Name: It is the name that appears on combo box of **Scan Tab**  
     66Hint: it is a tooltip 
     67Description: it's just to say what this profile does. 
     68    
     69You can browse on the tabs and apply option that you wish to build 
     70a profile that you intend.     
    9671     
    97   <para> 
    98   Hint: it is a tooltip 
    99   </para> 
    100   
    101   <para> 
    102   Description: it's just to say what this profile does. 
    103   </para> 
    104     
    105     <para>You can browse on the tabs and apply option that you wish to build 
    106     a profile that you intend.     
     72Just press Ok and you save the profile 
     73How to use the recently created profile? 
     74You can find recently profile created on Combo box in Scan tab. So just fill the target, select profile and press scan. The option of your new profile are running on the scan.      
    10775     
    108     </para> 
    109     <para>Just press Ok and you save the profile</para> 
    110     <para>How to use the recently created profile? 
    111   You can find recently profile created on Combo box in Scan tab. So just fill the target, select profile and press scan. The option of your new profile are running on the scan.      
     76 
     77Editing a profile 
     78---------------------------- 
     79 
     80Use the key-stroke 
     81The key-stroke Edit Profile is *CTRL + E*  
    11282     
    113     </para> 
    114   </section> 
     83Acces from the Main Menu. 
     84Go to the **Main Menu** (the one on the top of the application), 
     85*Profile*; Edit Profile 
     86     
    11587 
    116   <section> 
    117     <title>Editing a profile</title> 
    118     <para>   </para> 
     88Creating a new profile based on an old one 
     89------------------------------------------------ 
     90 
     91This option is like copy a profile. If you have a Profile and you can create 
     92 a similar Profile, use it. 
     93 
     94Use the key-stroke 
     95In combo Box of Scan Tab select a profile. The key-stroke create Profile is *CTRL + R* 
     96 
     97Acces from the Main Menu. 
     98Select Profile in combo box of Scan tab and go to the **Main Menu** (the one on the top of the application), 
     99Profile; New Profile with Selected 
     100 
     101 
     102Delete Profiles 
     103----------------------------- 
    119104     
    120         <procedure> 
    121       <title>Use the key-stroke</title> 
    122         <step>The key-stroke Edit Profile is <accel>CTRL + E</accel>.</step> 
    123     </procedure>  
     105If you want delete a Profile by some reason it is possible.  
     106Only follow the one of the procedure 
    124107     
    125     <procedure> 
    126       <title>Acces from the Main Menu</title> 
    127       <step>Go to the <emphasis>Main Menu</emphasis> (the one on the top of the application), 
    128       <guimenu>Profile</guimenu>-&gt;<guimenuitem>Edit Profile</guimenuitem>.</step> 
    129     </procedure> 
     108Use the key-stroke 
     109In combo Box of Scan Tab select a profile. The key-stroke delete Profile is *CTRL + M*  
    130110     
    131   </section> 
     111Acces from the Main Menu. 
     112Select Profile in combo box of Scan tab and go to the **Main Menu** (the one on the top of the application), 
     113Profile; Delete Profile 
    132114 
    133   <section> 
    134     <title>Creating a new profile based on an old one</title> 
    135     <para> 
    136     This option is like copy a profile. If you have a Profile and you can create 
    137     a similar Profile, use it. 
     115 
     116Using Profile Editor 
     117 
     118Select Profile in combo box of Scan tab and go to **Main Menu** (the one on the top of the application), 
     119Profile ; Edit Profile. 
     120Press *Delete* button.  
    138121     
    139     </para> 
    140122 
    141       <procedure> 
    142       <title>Use the key-stroke</title> 
    143         <step>In combo Box of Scan Tab select a profile. The key-stroke create Profile is <accel>CTRL + R</accel>.</step> 
    144     </procedure>  
     123 
     124The profile editor structure 
     125--------------------------------------- 
     126 
     127Where is saved options? In options.xml, you can find in your  
     128*$HOME/.umit/*  
    145129     
    146     <procedure> 
    147       <title>Acces from the Main Menu</title> 
    148       <step>Select Profile in combo box of Scan tab and go to the <emphasis>Main Menu</emphasis> (the one on the top of the application), 
    149       <guimenu>Profile</guimenu>-&gt;<guimenuitem>New Profile with Selected</guimenuitem>.</step> 
    150     </procedure> 
     130 
     131The profile_editor.xml can be found on the same place and it uses options  
     132from options.xml 
    151133     
    152      
    153   </section> 
    154  
    155    
    156    
    157   <section> 
    158     <title>Delete Profiles</title> 
    159     <para> 
    160     If you want delete a Profile by some reason it is possible.  
    161     Only follow the one of the procedure 
    162      
    163     </para> 
    164    <procedure> 
    165       <title>Use the key-stroke</title> 
    166         <step>In combo Box of Scan Tab select a profile. The key-stroke delete Profile is <accel>CTRL + M</accel>.</step> 
    167     </procedure>  
    168      
    169     <procedure> 
    170       <title>Acces from the Main Menu</title> 
    171       <step>Select Profile in combo box of Scan tab and go to the <emphasis>Main Menu</emphasis> (the one on the top of the application), 
    172       <guimenu>Profile</guimenu>-&gt;<guimenuitem>Delete Profile</guimenuitem>.</step> 
    173     </procedure> 
    174      
    175     <procedure> 
    176       <title>Using Profile Editor</title> 
    177       <step>Select Profile in combo box of Scan tab and go to <emphasis>Main Menu</emphasis> (the one on the top of the application), 
    178       <guimenu>Profile</guimenu>-&gt;<guimenuitem>Edit Profile</guimenuitem>.</step> 
    179       <step> 
    180       Press <emphasis>Delete</emphasis> button.  
    181       </step> 
    182     </procedure>     
    183      
    184   </section> 
    185    
    186   <section> 
    187     <title>The profile editor structure</title> 
    188     <para>Where is saved options? In options.xml, you can find in your  
    189     <emphasis>$HOME/.umit/</emphasis> 
    190     </para> 
    191     <para> 
    192     The profile_editor.xml can be found on the same place and it uses options  
    193     from options.xml 
    194     </para> 
    195      
    196     <para>The widgets available for options is combo box, checkbox and text 
    197     entry. We have the box with numbers (for example, number of ports) to 
    198   use as parameter.      
    199     </para> 
    200   </section> 
    201 </article> 
     134The widgets available for options is combo box, checkbox and text 
     135entry. We have the box with numbers (for example, number of ports) to 
     136use as parameter.      

  • branch/sphinxdoc/src/static/profile_editor_1.png