Add man page

This commit is contained in:
Erik Dubois 2018-01-31 14:57:43 +01:00
parent ec094539b4
commit 488818edc4
2 changed files with 67 additions and 3 deletions

60
docs/man/fluxion.man Normal file
View File

@ -0,0 +1,60 @@
FLUXION(1) User Manuals FLUXION(1)
NAME
fluxion - Fluxion is a security auditing and social-engineering
research tool
SYNOPSIS
fluxion
fluxion -a [attack] -e [essid] -b [bssid] -- -j ...
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.
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
./fluxion -a [ATTACK] -e [ESSID] -b [BSSID] -c [CHANNEL] \
-- -a [AP INTERFACE] -j [JAMMING INTERFACE]
FILES
$HOME/fluxion/attack/*
/tmp/fluxspace/*
.DIAGNOSTICS
The following diagnostics may be issued on stderr:
Please checkout the other log files for more details or check
debug mode.
BUGS
Please report any bugs at:
https://github.com/FluxionNetwork/fluxion/issues
AUTHOR
Cyberfee, l3op, dlinkproto, vk496, MPX4132
SEE ALSO
aircrack-ng(8)
Linux Last change: MARCH 2018 2

10
fluxion
View File

@ -27,6 +27,9 @@ readonly FLUXIONRevision=2
# Declare window ration bigger = smaller windows
FLUXIONWindowRatio=4
# Print help if it is true
FluxionHelpTrue=false
# ============================================================ #
# ================= < Script Sanity Checks > ================= #
@ -73,16 +76,16 @@ source lib/FormatUtils.sh
source lib/ColorUtils.sh
source lib/IOUtils.sh
source lib/HashUtils.sh
source lib/Help.sh
# NOTE: These are configured after arguments are loaded (later).
# ============================================================ #
# =================== < Parse Parameters > =================== #
# ============================================================ #
if ! FLUXIONCLIArguments=$(
getopt --options="vdkrnmtb:e:c:l:a:" \
--longoptions="debug,version,killer,reloader,ratio,airmon-ng,multiplexer,target,test,bssid:,essid:,channel:,language:,attack:" \
getopt --options="vdkrnmtbh:e:c:l:a:h:r" \
--longoptions="debug,version,killer,reloader,ratio,help,airmon-ng,multiplexer,target,test,bssid:,essid:,channel:,language:,attack:" \
--name="FLUXION V$FLUXIONVersion.$FLUXIONRevision" -- "$@"
); then
echo -e "${CRed}Aborted$CClr, parameter error detected..."; exit 5
@ -104,6 +107,7 @@ eval set -- "$FLUXIONCLIArguments" # Set environment parameters.
while [ "$1" != "" -a "$1" != "--" ]; do
case "$1" in
-v|--version) echo "FLUXION V$FLUXIONVersion.$FLUXIONRevision"; exit;;
-h|--help) fluxion_help; exit;;
-d|--debug) readonly FLUXIONDebug=1;;
-k|--killer) readonly FLUXIONWIKillProcesses=1;;
-r|--reloader) readonly FLUXIONWIReloadDriver=1;;