ronin 1.4.1 → 1.5.0.rc1

data/man/ronin-help.1.md

@@ -0,0 +1,34 @@
+# ronin-help 1 "April 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin help` [*options*] [*COMMAND*]
+
+## DESCRIPTION
+
+Displays the list of available Commands or prints information on a specific
+COMMAND.
+
+## ARGUMENTS
+
+*COMMAND*
+  The optional command to get detailed help information on.
+
+## OPTIONS
+
+`-v`, `--[no-]verbose`
+  Enable verbose output.
+
+`-q`, `--[no-]quiet`
+  Disable verbose output.
+
+`--[no-]silent`
+  Silence all output.
+
+`--[no-]color`
+  Enables color output.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-hosts.1.md

@@ -0,0 +1,78 @@
+# ronin-hosts 1 "April 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin hosts` [*options*]
+
+## DESCRIPTION
+
+Manages HostNames.
+
+## OPTIONS
+
+`-v`, `--[no-]verbose`
+  Enable verbose output.
+
+`-q`, `--[no-]quiet`
+  Disable verbose output.
+
+`--[no-]silent`
+  Silence all output.
+
+`--[no-]color`
+  Enables color output.
+
+`-D`, `--database` *URI*
+  The database to URI (`mysql://user:password@host/ronin`).
+
+`--[no-]csv`
+  CSV output.
+
+`--[no-]xml`
+  XML output.
+
+`--[no-]yaml`
+  YAML output.
+
+`--[no-]json`
+  JSON output.
+
+`-i`, `--import` *FILE*
+  Imports HostNames from the FILE.
+
+`-I`, `--with-ips` *IP* [...]
+  Searches for HostNames associated with the IP Address(es).
+
+`-p`, `--with-ports` *PORT* [...]
+  Searches for HostNames associated with the PORT(s).
+
+`-D`, `--domain` *DOMAIN*
+  Searches for HostNames belonging to the DOMAIN (`co.uk`).
+
+`-T`, `--tld` *TLD*
+  Searches for HostNames with the Top-Level-Domain (TLD) (`ru`).
+
+`-l`, `--[no-]list`
+  Lists the HostNames.
+
+`-L`, `--lookup` *IP*
+  Looks the HostNames associated with the IP Address.
+
+## FILES
+
+*~/.ronin/*
+  Ronin configuration directory.
+
+*~/.ronin/database.log*
+  Database log.
+
+*~/.ronin/database.sqlite3*
+  The default sqlite3 Database file.
+
+*~/.ronin/database.yml*
+  Optional Database configuration.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-install.1.md

@@ -0,0 +1,79 @@
+# ronin-install 1 "APRIL 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin install` [*options*] *URI*
+
+## DESCRIPTION
+
+Installs Ronin Repositories.
+
+## ARGUMENTS
+
+*URI*
+  The URI of the Repository to be installed.
+
+## OPTIONS
+
+`-v`, `--[no-]verbose`
+  Enable verbose output.
+
+`-q`, `--[no-]quiet`
+  Disable verbose output.
+
+`--[no-]silent`
+  Silence all output.
+
+`--[no-]color`
+  Enables color output.
+
+`--[no-]rsync`
+  Installs the Repository using Rsync.
+
+`--[no-]svn`
+  Installs the Repository using SubVersion (SVN).
+
+`--[no-]hg`
+  Installs the Repository using Mercurial (Hg).
+
+`--[no-]git`
+  Installs the Repository using Git.
+
+## FILES
+
+*~/.ronin/*
+  Ronin configuration directory.
+
+*~/.ronin/repos*
+  Installation directory for Ronin Repositories.
+
+*~/.ronin/database.log*
+  Database log.
+
+*~/.ronin/database.sqlite3*
+  The default sqlite3 Database file.
+
+*~/.ronin/database.yml*
+  Optional Database configuration.
+
+## ENVIRONMENT
+
+HOME
+  Specifies the home directory of the user. Ronin will search for the `.ronin`
+  configuration directory within the home directory.
+
+## EXAMPLES
+
+`ronin install git://github.com/user/repo.git`
+  Installs a Ronin Repository using git.
+
+`ronin install --git git@example.com:/home/secret/repo`
+  Installs a Ronin Repository using git over ssh.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-repos(1) ronin-uninstall(1) ronin-update(1)

data/man/ronin-ips.1.md

@@ -0,0 +1,81 @@
+# ronin-ips 1 "April 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin ips` [*options*]
+
+## DESCRIPTION
+
+Manages IPAddresses.
+
+## OPTIONS
+
+`-v`, `--[no-]verbose`
+  Enable verbose output.
+
+`-q`, `--[no-]quiet`
+  Disable verbose output.
+
+`--[no-]silent`
+  Silence all output.
+
+`--[no-]color`
+  Enables color output.
+
+`-D`, `--database` *URI*
+  The database to URI (`mysql://user:password@host/ronin`).
+
+`--[no-]csv`
+  CSV output.
+
+`--[no-]xml`
+  XML output.
+
+`--[no-]yaml`
+  YAML output.
+
+`--[no-]json`
+  JSON output.
+
+`-i`, `--import` *FILE*
+  Imports HostNames from the FILE.
+
+`-4`, `--[no-]v4`
+  Searches for IPv4 addresses.
+
+`-6`, `--[no-]v6`
+  Searches for IPv6 addresses.
+
+`-p`, `--with-ports` *PORT* [...]
+  Searches for IPAddresses associated with the user PORT(s).
+
+`-I`, `--with-macs` *MAC* [...]
+  Searches for IPAddresses associated with the MAC Address(es).
+
+`-I`, `--with-hosts` *HOST* [...]
+  Searches for IPAddresses associated with the HOST(s).
+
+`-l`, `--[no-]list`
+  Lists the IPAddresses.
+
+`-L`, `--lookup` *IP*
+  Looks the IPAddresses associated with the IP Address.
+
+## FILES
+
+*~/.ronin/*
+  Ronin configuration directory.
+
+*~/.ronin/database.log*
+  Database log.
+
+*~/.ronin/database.sqlite3*
+  The default sqlite3 Database file.
+
+*~/.ronin/database.yml*
+  Optional Database configuration.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-net-proxy.1.md

@@ -0,0 +1,86 @@
+# ronin-net-proxy 1 "April 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin net:proxy` [*options*] SERVER
+
+## DESCRIPTION
+
+Starts the Ronin TCP/UDP Proxy.
+
+## ARGUMENTS
+
+*SERVER*
+  The `host:port` of the server to proxy.
+
+## OPTIONS
+
+`--[no-]tcp`
+  Enables or disables TCP mode.
+
+`--[no-]udp`
+  Enables or disables UDP mode.
+
+`--[no-]hexdump`
+  Enables or disables hexdump mode.
+
+`--host` HOST
+  The HOST the proxy will listen on. Defaults to "0.0.0.0".
+
+`--port` PORT
+  The PORT the proxy will listen on.
+
+`--rewrite-client` */REGEXP/:STRING*
+  Replace REGEXP with STRING in every client message.
+
+`--rewrite-server` */REGEXP/:STRING*
+  Replace REGEXP with STRING in every server message.
+
+`--rewrite` */REGEXP/:STRING*
+  Replace REGEXP with STRING in every message.
+
+`--ignore-client` */REGEXP/*
+  Ignore messages from the client matching the REGEXP.
+
+`--ignore-server` */REGEXP/*
+  Ignore messages from the server matching the REGEXP.
+
+`--ignore` */REGEXP/*
+  Ignore messages matching the REGEXP.
+
+`--close-client` */REGEXP/*
+  Closes the connection if the client sends a message matching the REGEXP.
+
+`--close-server` */REGEXP/*
+  Closes the connection if the server sends a message matching the REGEXP.
+
+`--close` */REGEXP/*
+  Closes the connection if the client or server sends a message matching the
+  REGEXP.
+
+`--reset-client` */REGEXP/*
+  Reset the connection if the client sends a message matching the REGEXP.
+
+`--reset-server` */REGEXP/*
+  Reset the connection if the server sends a message matching the REGEXP.
+
+`--reset` */REGEXP/*
+  Reset the connection if the client or server sends a message matching the
+  REGEXP.
+
+`-v`, `--[no-]verbose`
+  Enable verbose output.
+
+`-q`, `--[no-]quiet`
+  Disable verbose output.
+
+`--[no-]silent`
+  Silence all output.
+
+`--[no-]color`
+  Enables color output.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-repos.1.md

@@ -0,0 +1,77 @@
+# ronin-repos 1 "APRIL 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin repos` [*options*] [*REPO*]
+
+## DESCRIPTION
+
+Lists Ronin Repositories.
+
+## ARGUMENTS
+
+*REPO*
+  The name of the Repository to list.
+
+## OPTIONS
+
+`-v`, `--[no-]verbose`
+  Enable verbose output.
+
+`-q`, `--[no-]quiet`
+  Disable verbose output.
+
+`--[no-]silent`
+  Silence all output.
+
+`--[no-]color`
+  Enables color output.
+
+`-D`, `--database` *URI*
+  The database to URI (`mysql://user:password@host/ronin`).
+
+`--domain` *DOMAIN*
+  Searches for Repositories installed from the DOMAIN.
+
+`-n`, `--named` *NAME*
+  Searches for Repositories with the given NAME.
+
+`-t`, `--titled` *TITLE*
+  Searches for Repositories with the similar TITLE.
+
+`-d`, `--describing` *DESCRIPTION*
+  Searches for Repositories with the similar DESCRIPTION.
+
+`-L`, `--licensed-under` *LICENSE*
+  Searches for Repositories with the given LICENSE (`MIT`).
+
+## FILES
+
+*~/.ronin/*
+  Ronin configuration directory.
+
+*~/.ronin/repos*
+  Installation directory for Ronin Repositories.
+
+*~/.ronin/database.log*
+  Database log.
+
+*~/.ronin/database.sqlite3*
+  The default sqlite3 Database file.
+
+*~/.ronin/database.yml*
+  Optional Database configuration.
+
+## ENVIRONMENT
+
+HOME
+  Specifies the home directory of the user. Ronin will search for the `.ronin`
+  configuration directory within the home directory.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-install(1) ronin-uninstall(1) ronin-update(1)

data/man/ronin-uninstall.1.md

@@ -0,0 +1,67 @@
+# ronin-uninstall 1 "April 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin uninstall` [*options*] *REPO*
+
+## DESCRIPTION
+
+Uninstalls a Ronin Repositories.
+
+## ARGUMENTS
+
+*REPO*
+  The name of the Repository to uninstall.
+
+## OPTIONS
+
+`-v`, `--[no-]verbose`
+  Enable verbose output.
+
+`-q`, `--[no-]quiet`
+  Disable verbose output.
+
+`--[no-]silent`
+  Silence all output.
+
+`--[no-]color`
+  Enables color output.
+
+## EXAMPLES
+
+`ronin uninstall repo`
+  Uninstalls the repository with with the name `repo`.
+
+`ronin uninstall repo@github.com`
+  Uninstalls the repository with the name `repo` and from `github.com`.
+
+## FILES
+
+*~/.ronin/*
+  Ronin configuration directory.
+
+*~/.ronin/repos*
+  Installation directory for Ronin Repositories.
+
+*~/.ronin/database.log*
+  Database log.
+
+*~/.ronin/database.sqlite3*
+  The default sqlite3 Database file.
+
+*~/.ronin/database.yml*
+  Optional Database configuration.
+
+## ENVIRONMENT
+
+HOME
+  Specifies the home directory of the user. Ronin will search for the `.ronin`
+  configuration directory within the home directory.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-install(1) ronin-repos(1) ronin-update(1)