Changeset 4305

Show
Ignore:
Timestamp:
03/07/09 01:02:30 (4 years ago)
Author:
gpolo
Message:

Moved nisearch to .rst

Location:
branch/sphinxdoc
Files:
3 removed
3 modified
1 copied

Legend:

Unmodified
Added
Removed
  • branch/sphinxdoc/Makefile

    r4304 r4305  
    2828        searching \ 
    2929        wizard \ 
    30         nisearch \ 
    3130        scheduler \ 
    3231        smtpsetup 
     
    5251        @rm -f $(OUTDIR)/searching.html 
    5352        @rm -f $(OUTDIR)/wizard.html 
    54         @rm -f $(OUTDIR)/nisearch.html 
    5553        @rm -f $(OUTDIR)/scheduler.html 
    5654        @rm -f $(OUTDIR)/smtpsetup.html 
  • branch/sphinxdoc/Makefile-sphinx

    r4304 r4305  
    33SPHINXOPTIONS = 
    44 
    5 ALLSPHINXOPTIONS = -b $(BUILDER) -d build/doctrees $(SRCDIR) build/$(BUILDER) 
     5 
     6ALLSPHINXOPTIONS = -b $(BUILDER) -d build/doctrees $(SPHINXOPTIONS) \ 
     7                                   $(SRCDIR) build/$(BUILDER) 
    68 
    79.PHONY: html build clean 
  • branch/sphinxdoc/src/ni.rst

    r4304 r4305  
    44.. toctree:: 
    55 
     6   ni_search.rst 
    67   ni_graphs.rst 
  • branch/sphinxdoc/src/ni_search.rst

    r3953 r4305  
    1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook v4.4//EN" 
    2   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 
     1UMIT Network Inventory - Search 
     2=============================== 
    33 
    4 <article> 
    5   <artheader> 
    6     <title>UMIT Network Inventory - Search</title> 
    7     <author> 
    8       <firstname>Guilherme</firstname> 
    9       <surname>Polo</surname> 
    10       <copyright> 
    11         <year>2007</year> 
    12         <holder>Guilherme Polo</holder> 
    13       </copyright> 
    14     </author> 
    15   </artheader> 
     4.. sectionauthor:: Guilherme Polo <ggpolo@gmail.com> 
    165 
    17   <section> 
    18     <title>Introduction</title> 
    19     <para>The Network Inventory search system is designed to find devices 
    20     in Inventories. It searches based on Ports, Services,  
    21     Changes that happened, IP, MAC, Hostname, OS Match, OS Classes  
    22     and Fingerprint info. 
    23     </para> 
    24   </section> 
    256 
    26   <section> 
    27     <title>Performing a search</title> 
    28     <para>To search for something, just type whatever you want in the bar 
    29     placed at the top of Network Inventory and hit 'Enter' or click on that 
    30     icon search. Actually, to find devices it is important to follow some 
    31     very important rules.</para> 
     7Introduction 
     8------------ 
    329 
    33     <para>To find devices based on port, you should search for something like 
    34     this: port 80. Then it will search for devices containing port 80 in 
    35     any state. If you want to search for devices containing only ports higher 
    36     than 1024, you should do: port > 1024. The port syntax allows you to use 
    37     the operators: '>', '&#060;', '==', '!=', '>=' and '&#060;='. But you 
    38     can't use more than one at once.</para> 
     10The Network Inventory search system is designed to find devices 
     11in Inventories. It searches based on Ports, Services, Changes that happened, 
     12IP address, MAC, Hostname, OS Match, OS Classes and Fingerprint info. 
    3913 
    40     <para>To find devices based on service, you should search for something 
    41     like this: service apache. And will search for a service with that name. 
    42     </para> 
    4314 
    44     <para>To find devices based on some change, you should search for something 
    45     like this: change somechangetext.</para> 
     15Performing a search 
     16------------------- 
    4617 
    47     <para>To search based on things like hostname, ip, and others, you just 
    48     type the text. Searching devices by a valid ip is the fastest way to find 
    49     them right now.</para> 
    50   </section> 
    51    
    52   <section> 
    53     <title>Bugs</title> 
     18To search for something, just enter your search terms in the bar placed 
     19on the top of Network Inventory and hit *Enter* or click on the 
     20icon search. But note that in order to achieve better results it is important 
     21to follow the rules described below. 
    5422 
    55     <para>As your scan number grows in your Inventories, you will feel the 
    56     pain when you try to search for devices. Also, you may get angry when 
    57     you notice the search system is not really smart. And it may contain very 
    58     ugly bugs right now. Now that you know all the bad news, you can hear 
    59     the good ones =)</para> 
    60     <para>The search will get smarter eventually, when pysqlite starts  
    61     supporting FTS (Full Text Search) on some new version. Things 
    62     to attempt speeding up the results were not possible to be done  
    63     in time for Google Summer of Code 2007, but will be implemented 
    64     as time and some other things allows.</para> 
    65   </section> 
     23To find devices based on port, your query should be similar to: port 80. 
     24This will search for devices containing the port 80 in its results 
     25(in any state). If you want to search for devices containing only ports 
     26higher than 1024, you could do: port : 1024. 
     27The port syntax allows you to the following operators: '>', '<', '==', '!=', 
     28'>=', '<='. But at this point you can't use more than one at once. 
    6629 
    67 </article> 
     30To find devices based on service, the query should looks like this: 
     31service apache. And will search for a service with that name. 
     32 
     33To find devices based on some change, you should search for something 
     34like this: change somechangetext. 
     35 
     36To search based on things like hostname, ip, and others, just 
     37type the text. Searching devices by a valid ip is the fastest way to find 
     38them right now. 
     39 
     40Bugs 
     41---- 
     42 
     43As your scan number grows in your Inventories, you will feel the 
     44pain when trying to search for devices. Also, you may get angry when 
     45you notice the search system is not really smart.