Minor man page tweaks

2018-01-31 18:28:38 +01:00 · 2018-01-31 18:28:38 +01:00 · b8e948039d
parent 488818edc4
commit b8e948039d
2 changed files with 147 additions and 39 deletions
--- a/docs/man/fluxion.1
+++ b/docs/man/fluxion.1
@ -0,0 +1,76 @@
+.TH FLUXION 1 "MARCH 2018" Linux "User Manuals"
+.SH NAME
+fluxion \- Fluxion is a security auditing and social-engineering research tool
+.SH SYNOPSIS
+.B fluxion [-debug] [-l
+.I language
+.B ]
+.I attack
+.B ...
+.SH DESCRIPTION
+.B fluxion is a security auditing and social-engineering research tool. 
+It is a remake of linset by vk496 with (hopefully) less bugs 
+and more functionality. The script attempts to retrieve the WPA/WPA2 
+key from a target access point by means of a social engineering 
+(phising) attack. It's compatible with the latest release of Kali
+(rolling). Fluxion's attacks' setup is mostly manual, 
+but experimental auto-mode handles some of the attacks' 
+setup parameters.
+.SH OPTIONS
+.IP "-v "
+Print version number.
+.IP "--help "
+Print help page and exit with 0.
+.IP "-m "
+Run fluxion in manual mode instead of auto mode.
+.IP "-k "
+Kill wireless connection if it is connected.
+.IP "-d "
+Run fluxion in debug mode.
+.IP "-x "
+Try to run fluxion with xterm terminals instead of tmux.
+.IP "-r "
+Reload driver.
+.IP "-l <language>"
+Define a certain language.
+.IP "-e <essid>"
+Select the target network based on the ESSID.
+.IP "-c <channel>"
+Indicate the channel(s) to listen to.
+.IP "-a <attack>"
+Define a certain attack.
+.IP "--ratio <ratio>"
+Define the windows size. Bigger ratio -> smaller window size.
+Default is 4.
+.IP "-b <bssid>"
+Select the target network based on the access point MAC address.
+.IP "-j <jamming interface>"
+Define a certain jamming interface.
+.IP "-a <access point interface>"
+Define a certain access point interface.
+.SH FILES
+.I /tmp/fluxspace/
+.RS
+The system wide tmp directory. 
+.RE
+.I $FLUXION/attacks/
+.RS
+Folder where handshakes and passwords
+are stored in.
+.SH ENVIRONMENT
+.IP FLUXIONAuto 
+Automatically run fluxion in auto mode if exported.
+.IP FLUXIONDebug 
+Automatically run fluxion in debug mode if exported.
+.IP FLUXIONWIKillProcesses 
+Automatically kill any interfering process(es).
+.SH DIAGNOSTICS
+Please checkout the other log files or use 
+the debug mode.
+.SH BUGS
+Please report any bugs at: 
+https://github.com/FluxionNetwork/fluxion/issues
+.SH AUTHOR
+Cyberfee, l3op, dlinkproto, vk496, MPX4132
+.SH "SEE ALSO"
+.BR aircrack-ng (8),
--- a/docs/man/fluxion.man
+++ b/docs/man/fluxion.man
@ -1,60 +1,92 @@
-FLUXION(1)                     User Manuals                    FLUXION(1)
+FLUXION(1)                       User Manuals                       FLUXION(1)
+


 NAME
-    fluxion - Fluxion is a security auditing and social-engineering
-              research tool
+       fluxion  -  Fluxion  is  a  security  auditing  and  social-engineering
+       research tool

 SYNOPSIS
-    fluxion 
-    fluxion -a [attack] -e [essid] -b [bssid] -- -j ...
+       fluxion [-debug] [-l language ] attack ...

 DESCRIPTION
-    Fluxion is a security auditing and social-engineering research tool. 
-    It is a remake of linset by vk496 with (hopefully) less bugs 
-    and more functionality. The script attempts to retrieve the WPA/WPA2 
-    key from a target access point by means of a social engineering 
-    (phising) attack. It's compatible with the latest release of Kali
-    (rolling). Fluxion's attacks' setup is mostly manual, 
-    but experimental auto-mode handles some of the attacks' 
-    setup parameters. 
+       fluxion is a security auditing and  social-engineering  research  tool.
+       It  is  a remake of linset by vk496 with (hopefully) less bugs and more
+       functionality. The script attempts to retrieve the WPA/WPA2 key from  a
+       target  access point by means of a social engineering (phising) attack.
+       It's compatible with the latest release of  Kali  (rolling).  Fluxion's
+       attacks'  setup  is  mostly  manual, but experimental auto-mode handles
+       some of the attacks' setup parameters.

 OPTIONS
-     -a <attack> : Give a certain attack
-     -e <essid>  : Give a certain essid
-     -b <bssid>  : Give a certain bssid
-     --          : Marker is required
-     -j          : Give a certain jamming interface
-     -a          : Give a certain access point interface
-     -x          : Use xterm instead of tmux
-     -v          : Print version number
-     -d          : Run fluxion in debug mode
-     -k          : Kill wireless connection if it is connected
-     -m          : Run fluxion in manual mode instead of auto
-     -l          : Give a certain language
-     --help      : Print help page
+       -v     Print version number.

-     ./fluxion -a [ATTACK] -e [ESSID] -b [BSSID] -c [CHANNEL] \
-          -- -a [AP INTERFACE] -j [JAMMING INTERFACE]
+       --help Print help page and exit with 0.
+
+       -m     Run fluxion in manual mode instead of auto mode.
+
+       -k     Kill wireless connection if it is connected.
+
+       -d     Run fluxion in debug mode.
+
+       -x     Try to run fluxion with xterm terminals instead of tmux.
+
+       -r     Reload driver.
+
+       -l <language>
+              Define a certain language.
+
+       -e <essid>
+              Select the target network based on the ESSID.
+
+       -c <channel>
+              Indicate the channel(s) to listen to.
+
+       -a <attack>
+              Define a certain attack.
+
+       --ratio <ratio>
+              Define the windows size. Bigger ratio ->  smaller  window  size.
+              Default is 4.
+
+       -b <bssid>
+              Select the target network based on the access point MAC address.
+
+       -j <jamming interface>
+              Define a certain jamming interface.
+
+       -a <access point interface>
+              Define a certain access point interface.

 FILES
-     $HOME/fluxion/attack/*
-     /tmp/fluxspace/*
+       /tmp/fluxspace/
+              The system wide tmp directory.
+       $FLUXION/attacks/
+              Folder where handshakes and passwords are stored in.

-.DIAGNOSTICS
-     The following diagnostics may be issued on stderr:
+ENVIRONMENT
+       FLUXIONAuto
+              Automatically run fluxion in auto mode if exported.

-     Please checkout the other log files for more details or check
-     debug mode.
+       FLUXIONDebug
+              Automatically run fluxion in debug mode if exported.
+
+       FLUXIONWIKillProcesses
+              Automatically kill any interfering process(es).
+
+DIAGNOSTICS
+       Please checkout the other log files or use the debug mode.

 BUGS
-     Please report any bugs at: 
-     https://github.com/FluxionNetwork/fluxion/issues
+       Please  report  any  bugs  at:  https://github.com/FluxionNetwork/flux-
+       ion/issues

 AUTHOR
-     Cyberfee, l3op, dlinkproto, vk496, MPX4132
+       Cyberfee, l3op, dlinkproto, vk496, MPX4132

 SEE ALSO
-     aircrack-ng(8)
+       aircrack-ng(8),

-Linux                Last change: MARCH 2018                         2
+
+
+Linux                             MARCH 2018                        FLUXION(1)