.\" Generated by kramdown-man 1.0.1
.\" https://github.com/postmodern/kramdown-man#readme
.TH ronin 1 "2023-02-01" Ronin "User Manuals"
.SH NAME
.PP
ronin \- A Ruby toolkit for security research and development
.SH SYNOPSIS
.PP
\fBronin\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
.SH DESCRIPTION
.PP
Runs a Ronin \fICOMMAND\fP\.
.SH ARGUMENTS
.TP
\fICOMMAND\fP
The Ronin command to execute\.
.SH OPTIONS
.TP
\fB\-V\fR, \fB\-\-version\fR
Prints the Ronin version and exits\.
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help information
.SH COMMANDS
.TP
\fIasn\fP
Queries or searches for ASN information
.TP
\fIbanner\-grab\fP
Fetches the banner from one or more TCP services
.TP
\fIbitflip\fP
Prints every bit\-flip of the given string(s)
.TP
\fIbitsquat\fP
Finds bit\-flips of a domain
.TP
\fIcert\-dump\fP
Prints SSL\[sl]TLS certificate information
.TP
\fIcert\-gen\fP
Generates a new X509 certificate
.TP
\fIcert\-grab\fP
Downloads SSL\[sl]TLS certificates
.TP
\fIcompletion\fP
Manages the shell completion rules for ronin and all other ronin\-* commands
.TP
\fIdecode\fP, \fIdec\fP
Decodes each character of data from a variety of encodings
.TP
\fIdecrypt\fP
Decrypts data
.TP
\fIdns\fP
Performs a variety of DNS queries
.TP
\fIdns\-proxy\fP
Starts a DNS proxy
.TP
\fIemail\-addr\fP
Processes email addresses
.TP
\fIencode\fP, \fIenc\fP
Encodes each character of data into a variety of encodings
.TP
\fIencrypt\fP
Encrypts data
.TP
\fIentropy\fP
Filters lines by their entropy
.TP
\fIescape\fP
Escapes each special character for a variety of encodings
.TP
\fIextract\fP
Extracts common patterns from files\[sl]input
.TP
\fIgrep\fP
Searches files\[sl]input for common patterns
.TP
\fIhexdump\fP
Hexdumps data in a variaty of encodings and formats
.TP
\fIhighlight\fP
Syntax highlights file(s)\.
.TP
\fIhmac\fP
Calculates a Hash\-based Message Authentication Code (HMAC)
.TP
\fIhomoglyph\fP
Generates homoglyph equivalent words
.TP
\fIhost\fP
Processes hostname(s)
.TP
\fIhttp\fP
Send HTTP requests or spawn an interactive HTTP shell
.TP
\fIip\fP
Queries or processes IP addresses
.TP
\fIiprange\fP
Enumerates over IP ranges
.TP
\fIirb\fP
Start ronin\[cq]s interactive Ruby shell
.TP
\fImd5\fP
Calculates MD5 hashes of data
.TP
\fInetcat\fP, \fInc\fP
A netcat clone command
.TP
\fInew\fP
Creates a new Ruby project or a script
.TP
\fIpack\fP
Packs values into binary data
.TP
\fIproxy\fP
Starts a TCP\[sl]UDP\[sl]SSL\[sl]TLS intercept proxy server
.TP
\fIpublic\-suffix\-list\fP, \fIpublic\-suffixes\fP
Updates and parses the public suffix list file
.TP
\fIquote\fP
Produces quoted a string for a variety of programming languages
.TP
\fIrot\fP
Rotates each character of data within an alphabet
.TP
\fIsha1\fP
Calculates SHA1 hashes of data
.TP
\fIsha256\fP
Calculates SHA256 hashes of data
.TP
\fIsha512\fP
Calculates SHA512 hashes
.TP
\fIstrings\fP
Prints all strings within a file\[sl]stream belonging to the given character set
.TP
\fItips\fP
Prints a random tip on how to use ronin
.TP
\fItld\-list\fP, \fItlds\fP
Updates and parses the TLD list file
.TP
\fItypo\fP
Generates typos in words
.TP
\fItyposquat\fP
Finds typo squatted domains
.TP
\fIunescape\fP
Unescapes each escaped character from a variety of encodings
.TP
\fIunhexdump\fP
Decodes a hexdump back into raw data
.TP
\fIunpack\fP
Unpacks binary data
.TP
\fIunquote\fP
Unquotes a double\[sl]single quoted string
.TP
\fIurl\fP
Parses URLs
.TP
\fIxor\fP
XORs each character of data with a key\.
.SH AUTHOR
.PP
Postmodern 
.MT postmodern\.mod3\[at]gmail\.com
.ME
.SH SEE ALSO
.PP
.BR ronin\-help (1)
.BR ronin\-archive (1)
.BR ronin\-asn (1)
.BR ronin\-banner\-grab (1)
.BR ronin\-bitflip (1)
.BR ronin\-bitsquat (1)
.BR ronin\-cert\-dump (1)
.BR ronin\-cert\-gen (1)
.BR ronin\-cert\-grab (1)
.BR ronin\-completion (1)
.BR ronin\-decode (1)
.BR ronin\-decrypt (1)
.BR ronin\-dns (1)
.BR ronin\-dns\-proxy (1)
.BR ronin\-email\-addr (1)
.BR ronin\-encode (1)
.BR ronin\-encrypt (1)
.BR ronin\-entropy (1)
.BR ronin\-escape (1)
.BR ronin\-extract (1)
.BR ronin\-grep (1)
.BR ronin\-hexdump (1)
.BR ronin\-highlight (1)
.BR ronin\-hmac (1)
.BR ronin\-homoglyph (1)
.BR ronin\-host (1)
.BR ronin\-http (1)
.BR ronin\-ip (1)
.BR ronin\-iprange (1)
.BR ronin\-irb (1)
.BR ronin\-md5 (1)
.BR ronin\-netcat (1)
.BR ronin\-new (1)
.BR ronin\-pack (1)
.BR ronin\-proxy (1)
.BR ronin\-public\-suffix\-list (1)
.BR ronin\-quote (1)
.BR ronin\-rot (1)
.BR ronin\-sha1 (1)
.BR ronin\-sha256 (1)
.BR ronin\-sha512 (1)
.BR ronin\-strings (1)
.BR ronin\-tips (1)
.BR ronin\-tld\-list (1)
.BR ronin\-typo (1)
.BR ronin\-typosquat (1)
.BR ronin\-unarchive (1)
.BR ronin\-unescape (1)
.BR ronin\-unhexdump (1)
.BR ronin\-unpack (1)
.BR ronin\-unquote (1)
.BR ronin\-url (1)
.BR ronin\-xor (1)