[Update]# [skip-ci] Update docs

stanislav-web · Jun 6, 2017 · 43b5496 · 43b5496
1 parent 16e8f8b
commit 43b5496
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 31 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .idea
 /syslog/
-/tmp/
+/tmp/
+__pycache__/
diff --git a/docs/Installation-and-update.md b/docs/Installation-and-update.md
@@ -1,5 +1,5 @@
-### Installation
-
+Installation
+===============
 Python v3.3 is minor requirement.
 At the moment, the package can be installed from this repository [https://github.com/stanislav-web/OpenDoor](https://github.com/stanislav-web/OpenDoor)
 Now being tested, and the next will be published in other sources, such as Pypi.
@@ -11,7 +11,8 @@ Now being tested, and the next will be published in other sources, such as Pypi.
 |3.5|[![Build Status](https://travis-ci.org/stanislav-web/OpenDoor.svg?branch=master)](https://travis-ci.org/stanislav-web/OpenDoor)    | ?  | [![Build status](https://ci.appveyor.com/api/projects/status/3hmrb64ofdssi4qd?svg=true)](https://ci.appveyor.com/project/stanislav-web/opendoor)|
 |3.6|[![Build Status](https://travis-ci.org/stanislav-web/OpenDoor.svg?branch=master)](https://travis-ci.org/stanislav-web/OpenDoor)    | ?  | [![Build status](https://ci.appveyor.com/api/projects/status/3hmrb64ofdssi4qd?svg=true)](https://ci.appveyor.com/project/stanislav-web/opendoor)|
 
-   * **GNU Linux (Local installation and run)**
+GNU Linux (Local installation and run)
+---------------------------
 
 ```
  git clone https://github.com/stanislav-web/OpenDoor.git
@@ -22,7 +23,8 @@ Now being tested, and the next will be published in other sources, such as Pypi.
  python3 opendoor.py --host http://www.example.com
 ```
 
-   * **GNU Linux (Global. Preferably for OS distributions)**
+GNU Linux (Global. Preferably for OS distributions)
+---------------------------
 
 ```
  git clone https://github.com/stanislav-web/OpenDoor.git
@@ -33,7 +35,8 @@ Now being tested, and the next will be published in other sources, such as Pypi.
 ```
 
 
-   *  **Windows XP/7/8/10**
+Windows XP/7/8/10
+---------------------------
 
 I would recommend you to install GUI for Git at first if you dont have pre installed Git on your laptop.
 Please see [https://git-for-windows.github.io](https://git-for-windows.github.io)
@@ -59,12 +62,17 @@ Try your fist launch
         C:\opendoor>python3 opendoor.py -h
 ```
 
-   * **OSX**
-
+OSX
+---
+
 [TODO] Docs is not complete because package wasn't tested for Mac
 
-### Update
+Dependencies
+===============
+![Alt text](http://dl4.joxi.net/drive/2017/06/06/0001/0378/90490/90/bb7e76ca06.jpg "Requirements")
 
+Update
+===============
 You have an update a package using `git pull origin master` inside or run update process from interface:
 ```
 # GNU Linux

diff --git a/docs/Usage.md b/docs/Usage.md
@@ -1,8 +1,10 @@
-#### Basic usage
+[Basic usage](https://github.com/stanislav-web/OpenDoor/wiki/Usage#basic-usage)
+===============
 ```
 python3 opendoor.py --host http://www.example.com
 ```
-#### Help
+[Help](https://github.com/stanislav-web/OpenDoor/wiki/Usage#help)
+===============
 ```
 usage: opendoor.py [-h] [--host HOST] [-p PORT] [-m METHOD] [-t THREADS]
                    [-d DELAY] [--timeout TIMEOUT] [-r RETRIES]
@@ -64,10 +66,11 @@ Wordlist tools:
   -e EXTENSIONS, --extensions EXTENSIONS
                         Extensions filter -e php,json e.g
 ```
-#### Arguments description usage
+[Arguments description](https://github.com/stanislav-web/OpenDoor/wiki/Usage#arguments-description-usage)
+===============
 
-###### Application tools
-------
+Application tools
+---------------------------
 
 **--update** - update sources from CVS to latest
 
@@ -93,8 +96,8 @@ opendoor --examples
 opendoor --docs
 ```
 
-###### Required arguments
-------
+Required arguments
+---------------------------
 
 **--host** - target host (ip). Also might be required protocol. See examples
 
@@ -104,8 +107,8 @@ opendoor --host https://www.example.com
 opendoor --host 127.0.0.1
 ```
 
-###### Request tools
-------
+Request tools
+---------------------------
 
 **--port -p** - custom port. Default 80 for HTTP and 443 for HTTPS
 
@@ -174,8 +177,8 @@ opendoor --host https://www.example.com --proxy socks5://127.0.0.1:8888
 opendoor --host https://www.example.com --random-agent
 ```
 
-###### Debug tools
-------
+Debug tools
+---------------------------
 
 **--debug** - debug levels (1-3). Provides the ability to view detailed scanning progress
      - 1 step by step scan proccess
@@ -186,8 +189,8 @@ opendoor --host https://www.example.com --random-agent
 opendoor --host www.example.com --debug 1
 ```
 
-###### Sniff tools
-------
+Sniff tools
+---------------------------
 
 **--indexof -i** - detect Apache Index of/. Use method GET as default. Large files and auth required pages will be detected automatically for every scan
 
@@ -196,8 +199,8 @@ opendoor --host www.example.com --indexof
 opendoor --host www.example.com --i
 ```
 
-###### Stream tools
-------
+Stream tools
+---------------------------
 
 **--threads -t** - allowed threads. In order not to harm your computer there is a limit of 25 threads
 
@@ -206,8 +209,11 @@ opendoor --host www.example.com --threads 10
 opendoor --host www.example.com --t 15
 ```
 
-###### Wordlist tools
-------
+**CTRL+C** - pause scan
+**ENTER** - resume scan
+
+Wordlist tools
+---------------------------
 
 **--scan -s** - the application allows you to scan in two directions. Not only for directories but also allows you to find subdomains
 
@@ -246,8 +252,8 @@ opendoor --host example.com --extensions php,html
 opendoor --host example.com --e htm,py
 ```
 
-###### Reports tools
-------
+Reports tools
+---------------------------
 
 **--reports** - scan reporting format. At the moment there has several providers for reports. Also you can help develop by expanding this functionality
 

diff --git a/src/controller.py b/src/controller.py
@@ -116,7 +116,6 @@ def docs_action():
         except (AttributeError, PackageError) as error:
             raise SrcError(error)
 
-
     @staticmethod
     def version_action():
         """

diff --git a/src/core/options/options.py b/src/core/options/options.py
@@ -266,9 +266,7 @@ def __init__(self):
 
         groupped = {}
         try:
-
             self.parser = ThrowingArgumentParser(formatter_class=RawDescriptionHelpFormatter)
-
             required_named = self.parser.add_argument_group('required named options')
             required_named.add_argument('--host', help="Target host (ip); --host http://example.com")
             arguments_len = len(__arguments)