---
name: "admin"
section: "7ctrlproxy"
platform: "linux"
package: "ctrlproxy"
version: "2.6.1-1"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/admin/7ctrlproxy"
---

# admin(7ctrlproxy)

Remote administration

## NAME

admin - Remote administration

## DESCRIPTION

This module provides a simple interface for remote administration of ControlProxy. Commands can be executed by either using the /CTRLPROXY command in your IRC client or sending them to the nick**ctrlproxy** on a network.

The syntax for the commands is very simple: the command should be followed by one or arguments, seperated by spaces. Quoting is not supported.

## COMMANDS

The following commands are supported:

- ADDNETWORK \<name\>

  Adds a new network with the specified name.

- ADDLISTEN \<network\> \<type\> \[\<key\>=\<value\>\] \[...\]

  Adds a new 'listener' to the specified network with the specified type and options.

  Example: **addlisten OPN ipv4 port=6676**

- ADDSERVER \<network\> \<type\> \[\<key\>=\<value\>\] \[...\]

  Adds a new server to the specified network with the specified type and options.

  Example: **addserver OPN ipv4 host=irc.freenode.net**

- CONNECT \<network\>

  Connect to the specifed network. Ctrlproxy will connect to the first known server for this network.

- DIE

  Disconnect all clients and servers and exit ctrlproxy.

- DISCONNECT \<network\>

  Disconnect from the specified network.

- DETACH

  Detach client from the proxy.

- LISTNETWORKS

  Prints out a list of all networks ctrlproxy is connected to at the moment.

- LOADMODULE \<location\>

  Load DSO module (aka 'plugin') from the specified location.

- RELOADMODULE \<location\>

  Reload the DSO module at the specified location. This does the same as doing a **UNLOADMODULE** followed by a **LOADMODULE**.

- UNLOADMODULE \<location\>

  Unload the DSO module which was loaded from the specified location. This may or may not work correctly, depending on the plugin you are trying to unload.

- LISTMODULES

  Prints out a list of all currently loaded plugins.

- DUMPCONFIG

  Prints out the current configuration file XML data.

- SAVECONFIG

  Save the (updated) XML configuration file to the location it was loaded from (usually *$HOME/.ctrlproxyrc*).

- HELP

  Prints out list of available commands.

## EXAMPLE COMMANDS

Adding a new network called 'OFTC', listening for incoming connections on port 6667.

-

  ADDNETWORK OFTC ADDSERVER OFTC ipv4 host=irc.oftc.net ADDLISTEN OFTC ipv4 port=6667 CONNECT OFTC

## CONFIGURATION

The following XML elements are supported:

- without\_privmsg

  If this element is present, you can not execute admin commands by sending them to the nick 'ctrlproxy'. This can be useful for IRC clients that don't allow unknown IRC commands to be executed.

## VERSION

This man page is valid for version 0.1 of the plugin.

## SEE ALSO

[ctrlproxyrc(5)](/ctrlproxyrc/5.md), [ctrlproxy(1)](/ctrlproxy/1.md), http://ctrlproxy.vernstok.nl/: *http://ctrlproxy.vernstok.nl/*

## AUTHOR

Jelmer Vernooij: *mailto:*