.\" Generated by kramdown-man 1.0.1
.\" https://github.com/postmodern/kramdown-man#readme
.TH ronin-masscan-convert 1 "2023-03-01" Ronin Masscan "User Manuals"
.SH NAME
.PP
ronin\-masscan\-scan \- Runs masscan and outputs data as JSON or CSV or imports into the database
.SH SYNOPSIS
.PP
\fBronin\-masscan scan\fR \[lB]options\[rB] \fB\-\-\fR \fImasscan\[ru]options\fP \.\.\.
.SH DESCRIPTION
.PP
Runs \fBmasscan\fR and outputs data as JSON or CSV or imports into the database\.
.SH ARGUMENTS
.TP
\fImasscan\[ru]options\fP
Additional options for the \fBmasscan\fR command\.
.SH OPTIONS
.TP
\fB\-\-db\fR \fINAME\fP
The database name to connect to\. Defaults to \fBdefault\fR if not given\.
.TP
\fB\-\-db\-uri\fR \fIURI\fP
The explicit database URI to connect to
(ex: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]db\fR)\.
.TP
\fB\-\-db\-file\fR \fIPATH\fP
The sqlite3 database file to use\.
.TP
\fB\-\-sudo\fR
Explicitly run \fBmasscan\fR under \fBsudo\fR\. If the option is not given, then
\fBsudo\fR will automatically be enabled if the \fImasscan\[ru]options\fP includes a
privileged option (ex: \fB\-sS\fR, \fB\-O\fR, etc)\.
.TP
\fB\-o\fR, \fB\-\-output\fR \fIFILE\fP
Sets the output file to save the \fBmasscan\fR scan results to\. May be a \fB\.xml\fR,
\fB\.json\fR, or \fB\.csv\fR file\.
.TP
\fB\-F\fR, \fB\-\-output\-format\fR \fBjson\fR\[or]\fBcsv\fR
Explicitly specify the output format to JSON or CSV\. If the option is
not given, the output format Will be inferred from the \fB\-\-output\fR \fIFILE\fP file
extension\.
.TP
\fB\-\-import\fR
Imports the \fBmasscan\fR scan results into the Ronin database\.
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help information
.SH ENVIRONMENT
.TP
\fIHOME\fP
The user\[cq]s home directory\.
.TP
\fIXDG\[ru]CONFIG\[ru]HOME\fP
Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
.TP
\fIXDG\[ru]DATA\[ru]HOME\fP
Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
.SH FILES
.TP
\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
The default sqlite3 database file\.
.TP
\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
Optional database configuration\.
.SH EXAMPLES
.PP
Port scans \fB192\.168\.1\.1\fR and save the scan results to a JSON file:
.PP
.RS 4
.EX
\[Do] ronin\-masscan scan \-o scan\.json \-\- 192\.168\.1\.1 \-p80,443,\.\.\.
.EE
.RE
.PP
Service scans \fB192\.168\.1\.1\fR and saves the scan results to the Ronin database:
.PP
.RS 4
.EX
\[Do] ronin\-masscan scan \-\-import \-\- 192\.168\.1\.1 \-p80,443,\.\.\.
.EE
.RE
.SH AUTHOR
.PP
Postmodern 
.MT postmodern\.mod3\[at]gmail\.com
.ME