.TH cewl "1" "Aug 2016" "CEWL 5.2" "custom word list generator"
.\" Text automatically generated by txt2man
.SH NAME
\fBcewl \fP- custom word list generator
.SH SYNOPSIS
.nf
.fam C
\fBcewl\fP [\fIOPTION\fP] \.\.\. \fIURL\fP
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
CeWL (Custom Word List generator) is a ruby app which spiders a given \fIURL\fP, up to a specified depth, and returns
a list of words which can then be used for password crackers such as John the Ripper. Optionally, CeWL can follow
external links.
.PP
CeWL can also create a list of email addresses found in mailto links. These email addresses can be used as
usernames in brute force actions.
.PP
CeWL is pronounced "cool".
.SH OPTIONS
.TP
.B
\fB--help\fP, \fB-h\fP
Show the help.
.TP
.B
\fB--count\fP, \fB-c\fP
Show the count for each word found.
.TP
.B
\fB--depth\fP N, \fB-d\fP N
The depth to spider to. Default: 2.
.TP
.B
\fB--email\fP, \fB-e\fP
Include email addresses in the search. This option will create an email list, after the words list, that can be used as usernames in brute force actions.
.TP
.B
\fB--email_file\fP FILE
Filename for email output. Must be used with '\fB-e\fP' option. If used, the email list created by '\fB-e\fP' option will be written in a file and won't be shown in stdout.
.TP
.B
\fB--keep\fP, \fB-k\fP
Keep the downloaded files (in /tmp or in directory specified by '\fB--meta-temp-dir\fP' option). These files are acquired when using the '\fB-a\fP' option.
.TP
.B
\fB--meta\fP, \fB-a\fP
Consider the metadata found when processing a site. This option will download some files found in the site and will extract its metadata. So, the network traffic will be greater. The files will be downloaded in /tmp folder or in directory specified by '\fB--meta-temp-dir\fP' option. The metadata will be shown after the words list and can be used as elements for brute force actions.
.TP
.B
\fB--meta_file\fP FILE
Filename for metadata output. Must be used with '\fB-a\fP' option. If used, the metadata list created by '\fB-a\fP' option will be written in a file and won't be shown in stdout.
.TP
.B
\fB--meta-temp-dir\fP DIRECTORY
The directory used by exiftool when parsing files. Default: /tmp.
.TP
.B
\fB--min_word_length\fP N, \fB-m\fP N
The minimum word length. This strips out all words under the specified length. Default: 3.
.TP
.B
\fB--no-words\fP, \fB-n\fP
Don't output the wordlist.
.TP
.B
\fB--offsite\fP, \fB-o\fP
By default, the spider will only visit the site specified. With this option, CeWL will also visit external sites (that are quoted by hyperlinks).
.TP
.B
\fB--ua\fP USER-AGENT, \fB-u\fP USER-AGENT
Change the user-agent. The default is 'Ruby'. There are a list of valid user-agents at http://www.user-agents.org.
.TP
.B
\fB--write\fP FILE, \fB-w\fP FILE
Write the output to the file rather than to stdout.
.TP
.B
\fB--auth_type\fP TYPE
Type of authentication for websites that uses it. The current options are 'digest' and 'basic'.
.TP
.B
\fB--auth_user\fP USERNAME
Authentication username for websites.
.TP
.B
\fB--auth_pass\fP PASSWORD
Authentication password for websites.
.TP
.B
\fB--proxy_host\fP HOST
Proxy name or IP address, when needed.
.TP
.B
\fB--proxy_port\fP PORT
Proxy port, when needed. Default: 8080.
.TP
.B
\fB--proxy_username\fP USERNAME
Username for proxy, if required.
.TP
.B
\fB--proxy_password\fP PASSWORD
Password for proxy, if required.
.TP
.B
\fB--verbose\fP, \fB-v\fP
Verbose. Show extra output. Useful for debugs.
.TP
.B
\fIURL\fP
The site to spider.
.SH BUGS
Someone has reported that the spider misses some pages which are have querystrings on them. This issue isn't confirmed.
.SH SEE ALSO
fab-\fBcewl\fP(1)
.SH AUTHOR
The CeWL was written by Robin Wood <robin@digi.ninja>.
.PP
This manual page was written by Joao Eriberto Mota Filho <eriberto@debian.org>
for the Debian project (but may be used by others).